From 01eb231bde072eb6a5f134d93d86308b4406e814 Mon Sep 17 00:00:00 2001 From: Drew Powers Date: Sat, 18 Nov 2023 17:33:06 -0500 Subject: [PATCH] Fix defaultNonNullable behavior --- .../examples/digital-ocean-api.ts | 307 +- .../DigitalOcean-public.v2.yaml | 12 + .../apps/models/app_functions_spec.yml | 9 +- .../resources/apps/models/app_route_spec.yml | 2 +- .../apps/models/app_service_spec.yml | 8 +- .../apps/models/app_static_site_spec.yml | 8 +- .../apps/models/apps_image_source_spec.yml | 15 +- .../databases/databases_add_user.yml | 9 +- .../databases/databases_create_cluster.yml | 2 + .../databases_create_kafka_topic.yml | 1 + .../databases/databases_create_replica.yml | 1 + .../databases_delete_kafka_topic.yml | 1 + .../databases/databases_get_kafka_topic.yml | 1 + .../databases/databases_list_kafka_topics.yml | 1 + .../databases_update_clusterSize.yml | 1 + .../databases_update_kafka_topic.yml | 15 +- .../databases_update_onlineMigration.yml | 33 +- .../curl/databases_create_cluster.yml | 2 +- .../curl/databases_create_replica.yml | 2 +- .../curl/databases_update_clusterSize.yml | 2 +- .../curl/databases_update_onlineMigration.yml | 4 +- .../examples/curl/databases_update_topic.yml | 2 +- .../examples/go/databases_create_cluster.yml | 1 + .../examples/go/databases_create_replica.yml | 1 + .../examples/go/databases_create_topic.yml | 26 + .../examples/go/databases_delete_topic.yml | 19 + .../examples/go/databases_get_topic.yml | 19 + .../examples/go/databases_list_topics.yml | 17 + .../go/databases_update_clusterSize.yml | 1 + .../examples/go/databases_update_topic.yml | 26 + .../python/databases_create_cluster.yml | 1 + .../python/databases_create_replica.yml | 3 +- .../python/databases_update_clusterSize.yml | 3 +- .../databases_update_onlineMigration.yml | 1 + .../databases/models/database_cluster.yml | 6 + .../models/database_cluster_resize.yml | 7 + .../databases/models/database_replica.yml | 6 + .../databases/models/kafka_topic_config.yml | 11 +- .../databases/models/kafka_topic_update.yml | 16 +- .../databases/models/kafka_topic_verbose.yml | 5 +- .../databases/models/source_database.yml | 9 + .../databases/models/user_settings.yml | 1 - .../databases/responses/database_cluster.yml | 1 + .../databases/responses/database_clusters.yml | 1 + .../databases/responses/kafka_topic.yml | 3 +- .../kubernetes/kubernetes_get_credentials.yml | 2 +- .../kubernetes/kubernetes_get_kubeconfig.yml | 3 +- ...monitoring_get_appCPUPercentageMetrics.yml | 6 + ...itoring_get_appMemoryPercentageMetrics.yml | 6 + .../monitoring_get_appRestartCountMetrics.yml | 6 + ...monitoring_get_appCPUPercentageMetrics.yml | 39 + ...itoring_get_appMemoryPercentageMetrics.yml | 39 + .../monitoring_get_appRestartCountMetrics.yml | 39 + .../resources/monitoring/parameters.yml | 18 + .../responses/app_metric_response.yml | 19 + .../monitoring/responses/examples.yml | 20 + .../resources/uptime/models/notification.yml | 2 +- .../github-api-export-type-immutable.ts | 2368 +++++++-- .../examples/github-api-immutable.ts | 2368 +++++++-- .../examples/github-api-next.ts | 2267 +++++++-- .../examples/github-api-next.yaml | 3026 +++++++++--- .../openapi-typescript/examples/github-api.ts | 2370 +++++++-- .../examples/github-api.yaml | 3914 ++++++++++----- .../openapi-typescript/examples/stripe-api.ts | 1435 +++++- .../examples/stripe-api.yaml | 4221 ++++++++++++++--- .../src/transform/schema-object.ts | 4 +- .../test/transform/operation-object.test.ts | 59 + 67 files changed, 18423 insertions(+), 4430 deletions(-) create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_topic.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_delete_topic.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_topic.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_topics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_topic.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appCPUPercentageMetrics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appMemoryPercentageMetrics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appRestartCountMetrics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/app_metric_response.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index ed1d7c6cf..d8d61bdf3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -3838,6 +3838,66 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/monitoring/metrics/apps/memory_percentage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get App Memory Percentage Metrics + * @description To retrieve memory percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/memory_percentage`. + */ + get: operations["monitoring_get_appMemoryPercentageMetrics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/apps/cpu_percentage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get App CPU Percentage Metrics + * @description To retrieve cpu percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/cpu_percentage`. + */ + get: operations["monitoring_get_appCPUPercentageMetrics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/apps/restart_count": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get App Restart Count Metrics + * @description To retrieve restart count metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/restart_count`. + */ + get: operations["monitoring_get_appRestartCountMetrics.yml"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/projects": { parameters: { query?: never; @@ -5722,11 +5782,23 @@ export interface components { */ repository?: string; /** - * @description The repository tag. Defaults to `latest` if not provided. + * @description The repository tag. Defaults to `latest` if not provided and no digest is provided. Cannot be specified if digest is provided. * @default latest * @example latest */ tag: string; + /** + * @description The image digest. Cannot be specified if tag is provided. + * @example sha256:795e91610e9cccb7bb80893fbabf9c808df7d52ae1f39cd1158618b4a33041ac + */ + digest?: string; + deploy_on_push?: { + /** + * @description Whether to automatically deploy new images. Can only be used for images hosted in DOCR and can only be used with an image tag, not a specific digest. + * @example true + */ + enabled?: boolean; + }; }; app_variable_definition: { /** @@ -5964,7 +6036,7 @@ export interface components { /** A criterion for routing HTTP traffic to a component. */ app_route_spec: { /** - * @description An HTTP path prefix. Paths must start with / and must be unique across all components within an app. + * @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; @@ -5975,7 +6047,7 @@ export interface components { preserve_path_prefix?: boolean; }; app_service_spec: components["schemas"]["app_component_base"] & components["schemas"]["app_component_instance_base"] & { - cors?: components["schemas"]["apps_cors_policy"]; + cors?: components["schemas"]["apps_cors_policy"] & unknown & unknown; health_check?: components["schemas"]["app_service_spec_health_check"]; /** * Format: int64 @@ -5992,7 +6064,10 @@ export interface components { * ] */ internal_ports?: number[]; - /** @description A list of HTTP routes that should be routed to this component. */ + /** + * @deprecated + * @description (Deprecated - Use Ingress Rules instead). A list of HTTP routes that should be routed to this component. + */ routes?: components["schemas"]["app_route_spec"][]; }; app_static_site_spec: WithRequired & { @@ -6018,8 +6093,11 @@ export interface components { * @example dist/ */ output_dir?: string; - cors?: components["schemas"]["apps_cors_policy"]; - /** @description A list of HTTP routes that should be routed to this component. */ + cors?: components["schemas"]["apps_cors_policy"] & unknown & unknown; + /** + * @deprecated + * @description (Deprecated - Use Ingress Rules instead). A list of HTTP routes that should be routed to this component. + */ routes?: components["schemas"]["app_route_spec"][]; }; app_job_spec: components["schemas"]["app_component_base"] & components["schemas"]["app_component_instance_base"] & { @@ -6070,8 +6148,11 @@ export interface components { window?: components["schemas"]["app_alert_spec_window"]; }; app_functions_spec: { - cors?: components["schemas"]["apps_cors_policy"]; - /** @description A list of HTTP routes that should be routed to this component. */ + cors?: components["schemas"]["apps_cors_policy"] & unknown & unknown; + /** + * @deprecated + * @description (Deprecated - Use Ingress Rules instead). A list of HTTP routes that should be routed to this component. + */ routes?: components["schemas"]["app_route_spec"][]; /** * @description The name. Must be unique across all components within the same app. @@ -7535,7 +7616,7 @@ export interface components { * @description An identifier for the ACL. * @example aaa */ - id: string; + id?: string; /** * @description A regex for matching the topic(s) that this ACL should apply to. * @example topic-abc.* @@ -7786,6 +7867,11 @@ export interface components { * @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; }; database_backup: { /** @@ -8448,6 +8534,15 @@ export interface components { * @example false */ disable_ssl?: boolean; + /** + * @description List of databases that should be ignored during migration. + * @default [] + * @example [ + * "db0", + * "db1" + * ] + */ + ignore_dbs: string[]; }; database_cluster_resize: { /** @@ -8461,6 +8556,11 @@ export interface components { * @example 3 */ num_nodes: number; + /** + * @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; }; backup: { /** @@ -8523,6 +8623,11 @@ export interface components { 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; }; database: { /** @@ -8760,12 +8865,6 @@ export interface components { * @example 604800000 */ segment_ms: number; - /** - * @description Whether unclean_leader_election_enable specifies whether to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. - * @default false - * @example false - */ - unclean_leader_election_enable: boolean; }; kafka_topic_create: components["schemas"]["kafka_topic_base"] & { config?: components["schemas"]["kafka_topic_config"]; @@ -8809,7 +8908,7 @@ export interface components { * @description The name of the Kafka topic. * @example events */ - name: string; + name?: string; /** * @description The state of the Kafka topic. * @example active @@ -8825,9 +8924,17 @@ export interface components { config?: components["schemas"]["kafka_topic_config"]; }; kafka_topic_update: { - topic?: components["schemas"]["kafka_topic_base"] & { - config?: components["schemas"]["kafka_topic_config"]; - }; + /** + * @description The number of nodes to replicate data across the cluster. + * @example 2 + */ + replication_factor?: number; + /** + * @description The number of partitions available for the topic. On update, this value can only be increased. + * @example 3 + */ + partition_count?: number; + config?: components["schemas"]["kafka_topic_config"]; }; domain: { /** @@ -11872,7 +11979,7 @@ export interface components { /** @description The notification settings for a trigger alert. */ notification: { /** - * @description An email to notify on an alert trigger. + * @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" * ] @@ -13905,6 +14012,18 @@ export interface components { "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 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: { @@ -14844,6 +14963,16 @@ export interface components { * @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 project. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 @@ -16669,7 +16798,11 @@ export interface operations { * "username": "doadmin", * "password": "paakjnfe10rsrsmf" * }, - * "disable_ssl": false + * "disable_ssl": false, + * "ignore_dbs": [ + * "db0", + * "db1" + * ] * } */ "application/json": components["schemas"]["source_database"]; }; @@ -16761,7 +16894,8 @@ export interface operations { content: { /** @example { * "size": "db-s-4vcpu-8gb", - * "num_nodes": 3 + * "num_nodes": 3, + * "storage_size_mib": 163840 * } */ "application/json": components["schemas"]["database_cluster_resize"]; }; @@ -16942,7 +17076,8 @@ export interface operations { /** @example { * "name": "read-nyc3-01", * "region": "nyc3", - * "size": "db-s-2vcpu-4gb" + * "size": "db-s-2vcpu-4gb", + * "storage_size_mib": 61440 * } */ "application/json": WithRequired; }; @@ -17699,17 +17834,14 @@ export interface operations { requestBody?: { content: { /** @example { - * "topic": { - * "name": "customer-events", - * "partitions": 3, - * "replication": 2, - * "config": { - * "retention_bytes": -1, - * "retention_ms": 100000 - * } + * "partitions": 3, + * "replication": 2, + * "config": { + * "retention_bytes": -1, + * "retention_ms": 100000 * } * } */ - "application/json": WithRequired; + "application/json": components["schemas"]["kafka_topic_update"]; }; }; responses: { @@ -21139,6 +21271,117 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + monitoring_get_appMemoryPercentageMetrics: { + 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 Timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description 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"]["app_metric_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_get_appCPUPercentageMetrics: { + 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 Timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description 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"]["app_metric_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + "monitoring_get_appRestartCountMetrics.yml": { + 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 Timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description 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"]["app_metric_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; projects_list: { parameters: { query?: { diff --git a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml index 29d582b1e..43556bebe 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 @@ -1271,6 +1271,18 @@ paths: get: $ref: 'resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml' + /v2/monitoring/metrics/apps/memory_percentage: + get: + $ref: 'resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml' + + /v2/monitoring/metrics/apps/cpu_percentage: + get: + $ref: 'resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml' + + /v2/monitoring/metrics/apps/restart_count: + get: + $ref: 'resources/monitoring/monitoring_get_appRestartCountMetrics.yml' + /v2/projects: get: $ref: 'resources/projects/projects_list.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml index 1f6972bfd..3f31a28dc 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_spec.yml @@ -2,12 +2,17 @@ type: object properties: + cors: - $ref: apps_cors_policy.yml + allOf: + - $ref: apps_cors_policy.yml + - description: (Deprecated - Use Ingress Rules instead). + - deprecated: true routes: type: array - description: A list of HTTP routes that should be routed to this component. + description: (Deprecated - Use Ingress Rules instead). A list of HTTP routes that should be routed to this component. + deprecated: true items: $ref: app_route_spec.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_route_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_route_spec.yml index 73ee975a8..338c77551 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_route_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_route_spec.yml @@ -2,7 +2,7 @@ title: A criterion for routing HTTP traffic to a component. type: object properties: path: - description: An HTTP path prefix. Paths must start with / and must be unique across + description: (Deprecated - Use Ingress Rules instead). An HTTP path prefix. Paths must start with / and must be unique across all components within an app. type: string example: /api 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 fbfd095c2..500560967 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 @@ -5,7 +5,10 @@ allOf: - type: object properties: cors: - $ref: apps_cors_policy.yml + allOf: + - $ref: apps_cors_policy.yml + - description: (Deprecated - Use Ingress Rules instead). + - deprecated: true health_check: $ref: app_service_spec_health_check.yml @@ -32,7 +35,8 @@ allOf: routes: type: array - description: A list of HTTP routes that should be routed to this component. + description: (Deprecated - Use Ingress Rules instead). A list of HTTP routes that should be routed to this component. + deprecated: true items: $ref: app_route_spec.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_static_site_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_static_site_spec.yml index 051c10811..39a8666e8 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_static_site_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_static_site_spec.yml @@ -33,13 +33,17 @@ allOf: example: dist/ cors: - $ref: apps_cors_policy.yml + allOf: + - $ref: apps_cors_policy.yml + - description: (Deprecated - Use Ingress Rules instead). + - deprecated: true routes: type: array items: $ref: app_route_spec.yml - description: A list of HTTP routes that should be routed to this component. + description: (Deprecated - Use Ingress Rules instead). A list of HTTP routes that should be routed to this component. + deprecated: true required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml index 7af3aca4e..453c658b7 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml @@ -22,6 +22,19 @@ properties: tag: type: string - description: The repository tag. Defaults to `latest` if not provided. + description: The repository tag. Defaults to `latest` if not provided and no digest is provided. Cannot be specified if digest is provided. example: latest default: latest + + digest: + type: string + description: The image digest. Cannot be specified if tag is provided. + example: sha256:795e91610e9cccb7bb80893fbabf9c808df7d52ae1f39cd1158618b4a33041ac + + deploy_on_push: + type: object + properties: + enabled: + type: boolean + description: Whether to automatically deploy new images. Can only be used for images hosted in DOCR and can only be used with an image tag, not a specific digest. + example: true \ No newline at end of file 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 d96d90746..792daf61d 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 @@ -60,14 +60,11 @@ requestBody: name: app-03 settings: acl: - - id: acl128aaaa99239 - permission: produceconsume + - permission: produceconsume topic: customer-events - - id: acl293098flskdf - permission: produce + - permission: produce topic: customer-events.* - - id: acl128ajei20123 - permission: consume + - permission: consume topic: customer-events responses: 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 cee50a914..f065dc011 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 @@ -45,6 +45,7 @@ requestBody: version: "14" region: nyc3 size: db-s-2vcpu-4gb + storage_size_mib: 61440 num_nodes: 2 tags: - production @@ -57,6 +58,7 @@ requestBody: region: nyc3 size: db-s-2vcpu-4gb num_nodes: 2 + storage_size_mib: 61440 tags: - production rules: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml index 2a08f14ba..ae0333bb5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml @@ -51,6 +51,7 @@ responses: x-codeSamples: - $ref: 'examples/curl/databases_create_topic.yml' + - $ref: 'examples/go/databases_create_topic.yml' security: - bearer_auth: 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 31a25079a..b1c9cf465 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 @@ -38,6 +38,7 @@ requestBody: name: read-nyc3-01 region: nyc3 size: db-s-2vcpu-4gb + storage_size_mib: 61440 responses: '201': diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml index 69d684eed..eb597fde9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml @@ -37,6 +37,7 @@ responses: x-codeSamples: - $ref: 'examples/curl/databases_delete_topic.yml' + - $ref: 'examples/go/databases_delete_topic.yml' security: - bearer_auth: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml index bac8cbdd0..3ce862088 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml @@ -36,6 +36,7 @@ responses: x-codeSamples: - $ref: 'examples/curl/databases_get_topic.yml' + - $ref: 'examples/go/databases_get_topic.yml' security: - bearer_auth: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml index c754a4334..3bdb19f39 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml @@ -35,6 +35,7 @@ responses: x-codeSamples: - $ref: 'examples/curl/databases_list_topics.yml' + - $ref: 'examples/go/databases_list_topics.yml' security: - bearer_auth: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml index abf039057..03adabd5b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml @@ -29,6 +29,7 @@ requestBody: example: size: db-s-4vcpu-8gb num_nodes: 3 + storage_size_mib: 163840 responses: '202': diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml index 7b6b8e407..b68f9b468 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml @@ -21,16 +21,12 @@ requestBody: schema: allOf: - $ref: 'models/kafka_topic_update.yml' - required: - - topic example: - topic: - name: customer-events - partitions: 3 - replication: 2 - config: - retention_bytes: -1 - retention_ms: 100000 + partitions: 3 + replication: 2 + config: + retention_bytes: -1 + retention_ms: 100000 responses: '200': @@ -53,6 +49,7 @@ responses: x-codeSamples: - $ref: 'examples/curl/databases_update_topic.yml' + - $ref: 'examples/go/databases_update_topic.yml' security: - bearer_auth: 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 07c04ed69..0951c3e45 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 @@ -13,7 +13,7 @@ tags: - Databases parameters: - - $ref: 'parameters.yml#/database_cluster_uuid' + - $ref: "parameters.yml#/database_cluster_uuid" requestBody: required: true @@ -21,7 +21,7 @@ requestBody: content: application/json: schema: - $ref: 'models/source_database.yml' + $ref: "models/source_database.yml" example: source: @@ -31,30 +31,31 @@ requestBody: username: doadmin password: paakjnfe10rsrsmf disable_ssl: false + ignore_dbs: ["db0","db1"] responses: - '200': - $ref: 'responses/online_migration.yml' + "200": + $ref: "responses/online_migration.yml" - '401': - $ref: '../../shared/responses/unauthorized.yml' + "401": + $ref: "../../shared/responses/unauthorized.yml" - '404': - $ref: '../../shared/responses/not_found.yml' + "404": + $ref: "../../shared/responses/not_found.yml" - '429': - $ref: '../../shared/responses/too_many_requests.yml' + "429": + $ref: "../../shared/responses/too_many_requests.yml" - '500': - $ref: '../../shared/responses/server_error.yml' + "500": + $ref: "../../shared/responses/server_error.yml" default: - $ref: '../../shared/responses/unexpected_error.yml' + $ref: "../../shared/responses/unexpected_error.yml" x-codeSamples: - - $ref: 'examples/curl/databases_update_onlineMigration.yml' - - $ref: 'examples/python/databases_update_onlineMigration.yml' + - $ref: "examples/curl/databases_update_onlineMigration.yml" + - $ref: "examples/python/databases_update_onlineMigration.yml" security: - bearer_auth: - - 'write' + - "write" 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 e398fd32b..a7b9d8b74 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, "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"]}' \ "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 f196a2c43..1ff457b12 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"}' \ + -d '{"name":"read-nyc3-01", "region":"nyc3", "size": "db-s-2vcpu-4gb", "storage_size_mib": 61440}' \ "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_update_clusterSize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_clusterSize.yml index 38eb3b8e3..1adc9baeb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_clusterSize.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_clusterSize.yml @@ -3,5 +3,5 @@ source: |- curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ - -d '{"size":"db-s-4vcpu-8gb", "num_nodes":3}' \ + -d '{"size":"db-s-4vcpu-8gb", "num_nodes":3, "storage_size_mib":163840}' \ "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/resize" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_onlineMigration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_onlineMigration.yml index 682046eb0..71576d7ff 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_onlineMigration.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_onlineMigration.yml @@ -3,5 +3,5 @@ source: |- curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ - -d '{"source":{"host":"source-do-user-6607903-0.b.db.ondigitalocean.com","dbname":"defaultdb","port":25060,"username":"doadmin","password":"paakjnfe10rsrsmf"},"disable_ssl":false}' \ - "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/online-migration" + -d '{"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"]}' \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/online-migration" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_topic.yml index ccc02f18d..0c4b29999 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_topic.yml @@ -3,5 +3,5 @@ source: |- curl -X PUT \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ - -d '{"topic":{"name":"customer-events", "partition_count":3, "replication_factor": 3, "config": {"retentionMS": 1000000}}}' \ + -d '{"partition_count":3, "replication_factor": 3, "config": {"retentionMS": 1000000}}' \ "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/topics/customer-events" 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 6749fd091..468afe926 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 @@ -20,6 +20,7 @@ source: |- Region: "nyc3", SizeSlug: "db-s-2vcpu-4gb", NumNodes: 2, + StorageSizeMiB : 61440, } 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 032e5dafc..b8a7125da 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 @@ -18,6 +18,7 @@ source: |- Name: "read-nyc3-01", Region: "nyc3", Size: "db-s-2vcpu-4gb", + StorageSizeMiB : 61440, } 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_create_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_topic.yml new file mode 100644 index 000000000..b3ad4f9bc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_topic.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() + + createRequest := &DatabaseCreateTopicRequest{ + Name: "events", + PartitionCount: 3, + ReplicationFactor: 2, + Config: &TopicConfig{ + RetentionMS: 60000, + } + }, + + cluster, _, err := client.Databases.CreateTopic(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", createRequest) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_delete_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_delete_topic.yml new file mode 100644 index 000000000..0f0062c71 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_delete_topic.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() + + topicName := "events" + + _, err := client.Databases.DeleteTopic(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", topicName) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_topic.yml new file mode 100644 index 000000000..84ae581e8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_topic.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() + + topicName := "events" + + user, _, err := client.Databases.GetTopic(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", topicName) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_topics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_topics.yml new file mode 100644 index 000000000..67c8cea92 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_topics.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() + + replicas, _, err := client.Databases.ListTopics(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", nil) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_clusterSize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_clusterSize.yml index 9fa79953f..91f504d1d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_clusterSize.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_clusterSize.yml @@ -14,5 +14,6 @@ source: |- resizeRequest := &godo.DatabaseResizeRequest{ SizeSlug: "db-s-4vcpu-8gb", NumNodes: 3, + StorageSizeMib: 163840, } } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_topic.yml new file mode 100644 index 000000000..23155de06 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_topic.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() + + topicName := "events" + updateRequest := &DatabaseUpdateTopicRequest{ + PartitionCount: 3, + ReplicationFactor: 2, + Config: &TopicConfig{ + RetentionMS: 60000, + }, + } + + _, err := client.Databases.UpdateTopic(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", topicName, updateRequest) + } 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 b7a2ad4e9..6867c5436 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 @@ -12,6 +12,7 @@ source: |- "region": "nyc3", "size": "db-s-2vcpu-4gb", "num_nodes": 2, + "storage_size_mib": 61440, "tags": [ "production" ] 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 5a833580a..05a7d434b 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 @@ -8,7 +8,8 @@ source: |- create_req = { "name": "read-nyc3-01", "region": "nyc3", - "size": "db-s-2vcpu-4gb" + "size": "db-s-2vcpu-4gb", + "storage_size_mib": 61440, } 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_update_clusterSize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_clusterSize.yml index 58001ef33..b5d910d3b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_clusterSize.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_clusterSize.yml @@ -7,7 +7,8 @@ source: |- req = { "size": "db-s-4vcpu-8gb", - "num_nodes": 3 + "num_nodes": 3, + "storage_size_mib": 163840 } update_resp = client.databases.update_cluster_size(database_cluster_uuid="a7a8bas", body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_onlineMigration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_onlineMigration.yml index c0d35d413..d67fcb388 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_onlineMigration.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_onlineMigration.yml @@ -14,6 +14,7 @@ source: |- "password": "paakjnfe10rsrsmf" }, "disable_ssl": False + "ignore_dbs": ["db0","db1"] } update_resp = client.databases.update_online_migration(database_cluster_uuid="a7a8bas", body=req) 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 66720cd7c..59e564b37 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 @@ -133,6 +133,12 @@ properties: 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. required: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster_resize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster_resize.yml index 31660db90..c3ba5e5bd 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster_resize.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster_resize.yml @@ -13,6 +13,13 @@ properties: The number of nodes in the database cluster. Valid values are are 1-3. In addition to the primary node, up to two standby nodes may be added for highly available configurations. + 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. + required: - size 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 7c3b46679..9c86dff9f 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 @@ -69,6 +69,12 @@ properties: 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. required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_config.yml index 942ab0a94..e93995b53 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_config.yml @@ -223,13 +223,4 @@ properties: description: >- The segment_ms specifies the period of time after which the log will be forced to roll if the segment file isn't full. This ensures that - retention can delete or compact old data. - unclean_leader_election_enable: - type: boolean - example: false - default: false - description: >- - Whether unclean_leader_election_enable specifies whether to allow - replicas that are not insync to be elected as leaders as a last - resort. This may result in data loss since those leaders are not - insync. \ No newline at end of file + retention can delete or compact old data. \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_update.yml index f5c8b5b9e..b61d2455c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_update.yml @@ -1,9 +1,13 @@ type: object properties: - topic: - allOf: - - $ref: './kafka_topic_base.yml' - - properties: - config: - $ref: './kafka_topic_config.yml' \ No newline at end of file + replication_factor: + type: integer + example: 2 + description: The number of nodes to replicate data across the cluster. + partition_count: + type: integer + example: 3 + description: The number of partitions available for the topic. On update, this value can only be increased. + config: + $ref: './kafka_topic_config.yml' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_verbose.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_verbose.yml index 866bf5e03..57551ae6f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_verbose.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_topic_verbose.yml @@ -27,7 +27,4 @@ properties: $ref: './kafka_topic_partition.yml' config: - $ref: './kafka_topic_config.yml' - -required: -- name \ No newline at end of file + $ref: './kafka_topic_config.yml' \ No newline at end of file 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 b4d656266..996077dd5 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 @@ -28,3 +28,12 @@ properties: type: boolean description: Enables SSL encryption when connecting to the source database. example: false + ignore_dbs: + type: array + items: + type: string + example: + - db0 + - db1 + default: [] + description: List of databases that should be ignored during migration. 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 d201c20af..8a111fce7 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 @@ -29,7 +29,6 @@ properties: and 'produce' permission. 'admin' allows for 'produceconsume' as well as any operations to administer the topic (delete, update). required: - - id - topic - permission description: >- 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 23ca68158..cb1f33ec6 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 @@ -63,3 +63,4 @@ content: 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 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 e0496b14e..44c918ad7 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 @@ -61,3 +61,4 @@ content: 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 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_topic.yml index 56fccccaf..6057a2e9b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_topic.yml @@ -58,5 +58,4 @@ content: segment_bytes: 209715200 segment_index_bytes: 10485760 segment_jitter_ms: 0 - segment_ms: 604800000 - unclean_leader_election_enable: false \ No newline at end of file + segment_ms: 604800000 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml index 7ba3f27bd..09458f36c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml @@ -54,4 +54,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'write' 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 a2e0115f2..ef897dc2b 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 @@ -55,5 +55,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'write' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appCPUPercentageMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appCPUPercentageMetrics.yml new file mode 100644 index 000000000..8523ee74d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appCPUPercentageMetrics.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/apps/cpu_percentage?app_id=2db3c021-15ad-4088-bfe8-99dc972b9cf6&app_component=sample-application&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appMemoryPercentageMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appMemoryPercentageMetrics.yml new file mode 100644 index 000000000..f9e2c1b82 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appMemoryPercentageMetrics.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/apps/memory_percentage?app_id=2db3c021-15ad-4088-bfe8-99dc972b9cf6&app_component=sample-application&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appRestartCountMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appRestartCountMetrics.yml new file mode 100644 index 000000000..5a4723b4e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_appRestartCountMetrics.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/apps/restart_count?app_id=2db3c021-15ad-4088-bfe8-99dc972b9cf6&app_component=sample-application&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml new file mode 100644 index 000000000..3ab45648c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml @@ -0,0 +1,39 @@ +operationId: monitoring_get_appCPUPercentageMetrics + +summary: Get App CPU Percentage Metrics + +description: >- + To retrieve cpu percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/cpu_percentage`. +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/app_metric_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' + + +parameters: + - $ref: 'parameters.yml#/app_id' + - $ref: 'parameters.yml#/app_component' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_appCPUPercentageMetrics.yml' + +security: + - bearer_auth: + - 'read' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml new file mode 100644 index 000000000..2d66b0c11 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml @@ -0,0 +1,39 @@ +operationId: monitoring_get_appMemoryPercentageMetrics + +summary: Get App Memory Percentage Metrics + +description: >- + To retrieve memory percentage metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/memory_percentage`. +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/app_metric_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' + + +parameters: + - $ref: 'parameters.yml#/app_id' + - $ref: 'parameters.yml#/app_component' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_appMemoryPercentageMetrics.yml' + +security: + - bearer_auth: + - 'read' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml new file mode 100644 index 000000000..3057fbf09 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml @@ -0,0 +1,39 @@ +operationId: monitoring_get_appRestartCountMetrics.yml + +summary: Get App Restart Count Metrics + +description: >- + To retrieve restart count metrics for a given app, send a GET request to `/v2/monitoring/metrics/apps/restart_count`. +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/app_metric_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' + + +parameters: + - $ref: 'parameters.yml#/app_id' + - $ref: 'parameters.yml#/app_component' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_appRestartCountMetrics.yml' + +security: + - bearer_auth: + - '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 dad7b14bc..ea94bd258 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 @@ -7,6 +7,24 @@ droplet_id: schema: type: string +app_id: + in: query + name: app_id + description: The app UUID. + example: "2db3c021-15ad-4088-bfe8-99dc972b9cf6" + required: true + schema: + type: string + +app_component: + in: query + name: app_component + description: The app component name. + example: "sample-application" + required: false + schema: + type: string + network_interface: in: query name: interface diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/app_metric_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/app_metric_response.yml new file mode 100644 index 000000000..54dce10f3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/app_metric_response.yml @@ -0,0 +1,19 @@ +description: The response will be a JSON object with a key called `data` and `status`. + +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/metrics.yml' + + examples: + Memory: + $ref: './examples.yml#/app_memory_percentage' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/examples.yml index f1f22ad60..58f62df39 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/examples.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/responses/examples.yml @@ -183,3 +183,23 @@ droplet_filesystem: - '25832407040' - - 1635387120 - '25832407040' + +app_memory_percentage: + value: + status: success + data: + resultType: matrix + result: + - metric: + app_component: sample-application + app_component_instance: sample-application-0 + app_uuid: 'db3c021-15ad-4088-bfe8-99dc972b9cf6' + values: + - - 1634052360 + - '5.016600450090265357' + - - 1634052480 + - '12.015085955677299055' + - - 1634052600 + - '8.014941163855322308' + - - 1634052720 + - '32.016214285714285712' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/models/notification.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/models/notification.yml index 2914c7b6c..cac8becac 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/models/notification.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/models/notification.yml @@ -5,7 +5,7 @@ required: - email properties: email: - description: "An email to notify on an alert trigger." + 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" type: array 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 d97647512..b8d13cc62 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -724,7 +724,7 @@ export type paths = { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * 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; @@ -2274,8 +2274,6 @@ export type paths = { * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * For public repositories, you may instead use the `public_repo` scope. - * - * GitHub Apps must have the `security_events` read permission to use this endpoint. */ readonly get: operations["code-scanning/list-alerts-for-org"]; readonly put?: never; @@ -2297,7 +2295,7 @@ export type paths = { * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. */ readonly get: operations["codespaces/list-in-organization"]; readonly put?: never; @@ -2320,7 +2318,7 @@ export type paths = { * 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. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ readonly put: operations["codespaces/set-codespaces-access"]; readonly post?: never; @@ -2347,7 +2345,7 @@ export type paths = { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ readonly post: operations["codespaces/set-codespaces-access-users"]; /** @@ -2358,7 +2356,7 @@ export type paths = { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ readonly delete: operations["codespaces/delete-codespaces-access-users"]; readonly options?: never; @@ -2375,7 +2373,7 @@ export type paths = { }; /** * List organization secrets - * @description Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. + * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/list-org-secrets"]; @@ -2416,13 +2414,13 @@ export type paths = { }; /** * Get an organization secret - * @description Gets an organization secret without revealing its encrypted value. + * @description Gets an organization development environment secret without revealing its encrypted value. * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/get-org-secret"]; /** * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * You must authenticate using an access @@ -2432,7 +2430,7 @@ export type paths = { readonly post?: never; /** * Delete an organization secret - * @description Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-org-secret"]; readonly options?: never; @@ -2454,7 +2452,7 @@ export type paths = { readonly get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/set-selected-repos-for-org-secret"]; readonly post?: never; @@ -2474,13 +2472,13 @@ export type paths = { readonly get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @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). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/add-selected-repo-to-org-secret"]; readonly post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/remove-selected-repo-from-org-secret"]; readonly options?: never; @@ -2496,14 +2494,14 @@ export type paths = { readonly cookie?: never; }; /** - * Get Copilot for Business seat information and settings for an organization + * Get Copilot Business seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot for Business subscription, including seat breakdown + * Gets information about an organization's Copilot Business subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/get-copilot-organization-details"]; @@ -2523,12 +2521,12 @@ export type paths = { readonly cookie?: never; }; /** - * List all Copilot for Business seat assignments for an organization + * List all Copilot Business seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/list-copilot-seats"]; @@ -2550,30 +2548,30 @@ export type paths = { readonly get?: never; readonly put?: never; /** - * Add teams to the Copilot for Business subscription for an organization + * Add teams to the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot for Business seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Purchases a GitHub Copilot Business seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. * - * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". */ readonly post: operations["copilot/add-copilot-for-business-seats-for-teams"]; /** - * Remove teams from the Copilot for Business subscription for an organization + * Remove teams from the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for all members of each team specified. + * Cancels the Copilot Business seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -2594,30 +2592,30 @@ export type paths = { readonly get?: never; readonly put?: never; /** - * Add users to the Copilot for Business subscription for an organization + * Add users to the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot for Business seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Purchases a GitHub Copilot Business seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. * - * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". */ readonly post: operations["copilot/add-copilot-for-business-seats-for-users"]; /** - * Remove users from the Copilot for Business subscription for an organization + * Remove users from the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for each user specified. + * Cancels the Copilot Business seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -3074,7 +3072,8 @@ export type paths = { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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; @@ -3205,7 +3204,7 @@ export type paths = { * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. */ readonly get: operations["codespaces/get-codespaces-for-user-in-org"]; readonly put?: never; @@ -3230,7 +3229,10 @@ export type paths = { * Delete a codespace from the organization * @description Deletes a user's codespace. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * To use this endpoint you must authenticate using one of the following methods: + * + * - An access token with the `admin:org` scope + * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` */ readonly delete: operations["codespaces/delete-from-organization"]; readonly options?: never; @@ -3251,7 +3253,10 @@ export type paths = { * Stop a codespace for an organization user * @description Stops a user's codespace. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * To use this endpoint you must authenticate using one of the following methods: + * + * - An access token with the `admin:org` scope + * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` */ readonly post: operations["codespaces/stop-in-organization"]; readonly delete?: never; @@ -3268,14 +3273,14 @@ export type paths = { readonly cookie?: never; }; /** - * Get Copilot for Business seat assignment details for a user + * Get Copilot Business seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - readonly get: operations["copilot/get-copilot-seat-assignment-details-for-user"]; + readonly get: operations["copilot/get-copilot-seat-details-for-user"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -3439,6 +3444,306 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/organization-fine-grained-permissions": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List organization fine-grained permissions for an organization + * @description **Note**: This operation is in beta and subject to change. + * + * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + */ + readonly get: operations["orgs/list-organization-fine-grained-permissions"]; + 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": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get all organization roles for an organization + * @description Lists the organization roles available in this organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly get: operations["orgs/list-org-roles"]; + readonly put?: never; + /** + * Create a custom organization role + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly post: operations["orgs/create-custom-organization-role"]; + 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; + /** + * Remove all organization roles for a team + * @description Removes all assigned organization roles from a team. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/revoke-all-org-roles-team"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly 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; + }; + readonly get?: never; + /** + * Assign an organization role to a team + * @description Assigns an organization role to a team in an organization. + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly put: operations["orgs/assign-team-to-org-role"]; + readonly post?: never; + /** + * Remove an organization role from a team + * @description Removes an organization role from a team. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/revoke-org-role-team"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/organization-roles/users/{username}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + readonly post?: never; + /** + * Remove all organization roles for a user + * @description Revokes all assigned organization roles from a user. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/revoke-all-org-roles-user"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly 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; + }; + readonly get?: never; + /** + * Assign an organization role to a user + * @description Assigns an organization role to a member of an organization. + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly put: operations["orgs/assign-user-to-org-role"]; + readonly post?: never; + /** + * Remove an organization role from a user + * @description Remove an organization role from a user. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/revoke-org-role-user"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/organization-roles/{role_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get an organization role + * @description Gets an organization role that is available to this organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly get: operations["orgs/get-org-role"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a custom organization role. + * @description Deletes a custom organization role. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/delete-custom-organization-role"]; + readonly options?: never; + readonly head?: never; + /** + * Update a custom organization role + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly patch: operations["orgs/patch-custom-organization-role"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/organization-roles/{role_id}/teams": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List teams that are assigned to an organization role + * @description Lists the teams that are assigned to an organization role. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + 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; + }; + readonly "/orgs/{org}/organization-roles/{role_id}/users": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List users that are assigned to an organization role + * @description Lists organization members that are assigned to an organization role. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + 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; + }; readonly "/orgs/{org}/outside_collaborators": { readonly parameters: { readonly query?: never; @@ -3819,6 +4124,95 @@ export type paths = { 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; + }; + /** + * Get all custom properties for an organization + * @description Gets all custom properties defined for an organization. + * You must be an organization owner to use this endpoint. + */ + readonly get: operations["orgs/get-all-custom-properties"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly 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. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + readonly patch: operations["orgs/create-or-update-custom-properties"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/properties/schema/{custom_property_name}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a custom property for an organization + * @description Gets a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + readonly get: operations["orgs/get-custom-property"]; + /** + * 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. + * You must be an organization owner to use this endpoint. + */ + readonly put: operations["orgs/create-or-update-custom-property"]; + readonly post?: never; + /** + * Remove a custom property for an organization + * @description Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + readonly delete: operations["orgs/remove-custom-property"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/properties/values": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly 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; + /** + * 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. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + readonly patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + readonly trace?: never; + }; readonly "/orgs/{org}/public_members": { readonly parameters: { readonly query?: never; @@ -4251,7 +4645,7 @@ export type paths = { * Create a discussion * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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`. */ @@ -4315,7 +4709,7 @@ export type paths = { * Create a discussion comment * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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`. */ @@ -4650,6 +5044,8 @@ export type paths = { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * + * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ readonly get: operations["teams/check-permissions-for-repo-in-org"]; @@ -7159,9 +7555,6 @@ export type paths = { * * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. * - * GitHub Apps must have the `security_events` read - * permission to use this endpoint. - * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if you used `ref` in the request). @@ -7184,7 +7577,7 @@ export type paths = { }; /** * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. */ readonly get: operations["code-scanning/get-alert"]; readonly put?: never; @@ -7194,7 +7587,7 @@ export type paths = { readonly head?: never; /** * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. */ readonly patch: operations["code-scanning/update-alert"]; readonly trace?: never; @@ -7211,7 +7604,6 @@ export type paths = { * @description Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. */ readonly get: operations["code-scanning/list-alert-instances"]; readonly put?: never; @@ -7244,7 +7636,6 @@ export type paths = { * * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. @@ -7270,7 +7661,6 @@ export type paths = { * @description Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -7377,7 +7767,6 @@ export type paths = { * * For private repositories, you must use an access token with the `security_events` scope. * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. */ readonly get: operations["code-scanning/list-codeql-databases"]; readonly put?: never; @@ -7407,7 +7796,6 @@ export type paths = { * * For private repositories, you must use an access token with the `security_events` scope. * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. */ readonly get: operations["code-scanning/get-codeql-database"]; readonly put?: never; @@ -7429,7 +7817,7 @@ export type paths = { * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * scope for public repos. */ readonly get: operations["code-scanning/get-default-setup"]; readonly put?: never; @@ -7441,7 +7829,7 @@ export type paths = { * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * scope for public repos. */ readonly patch: operations["code-scanning/update-default-setup"]; readonly trace?: never; @@ -7504,7 +7892,7 @@ export type paths = { }; /** * 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)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @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)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. */ readonly get: operations["code-scanning/get-sarif"]; readonly put?: never; @@ -7677,7 +8065,7 @@ export type paths = { }; /** * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ readonly get: operations["codespaces/list-repo-secrets"]; readonly put?: never; @@ -7717,12 +8105,12 @@ export type paths = { }; /** * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ readonly get: operations["codespaces/get-repo-secret"]; /** * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * @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)." * * You must authenticate using an access @@ -7733,7 +8121,7 @@ export type paths = { readonly post?: never; /** * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ readonly delete: operations["codespaces/delete-repo-secret"]; readonly options?: never; @@ -7788,7 +8176,7 @@ export type paths = { readonly 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -8041,7 +8429,7 @@ export type paths = { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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-commit-comment"]; readonly delete?: never; @@ -8848,7 +9236,7 @@ export type paths = { readonly put?: never; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -8868,14 +9256,14 @@ export type paths = { }; /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ readonly get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -8883,7 +9271,7 @@ export type paths = { readonly post?: never; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -9580,11 +9968,10 @@ export type paths = { }; /** * Get an import status + * @deprecated * @description View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -9622,18 +10009,22 @@ export type paths = { readonly get: operations["migrations/get-import-status"]; /** * Start an import - * @description Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * @deprecated + * @description Start a source import to a GitHub repository using GitHub Importer. + * Importing into a GitHub repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * */ readonly put: operations["migrations/start-import"]; readonly post?: never; /** * Cancel an import + * @deprecated * @description Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ readonly delete: operations["migrations/cancel-import"]; @@ -9641,6 +10032,7 @@ export type paths = { readonly head?: never; /** * Update an import + * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. * @@ -9648,9 +10040,7 @@ export type paths = { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/update-import"]; readonly trace?: never; @@ -9664,13 +10054,12 @@ export type paths = { }; /** * Get commit authors + * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-commit-authors"]; readonly put?: never; @@ -9696,12 +10085,11 @@ export type paths = { readonly head?: never; /** * Map a commit author + * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ readonly patch: operations["migrations/map-commit-author"]; @@ -9716,11 +10104,10 @@ export type paths = { }; /** * Get large files + * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ readonly get: operations["migrations/get-large-files"]; @@ -9747,15 +10134,14 @@ export type paths = { readonly head?: never; /** * Update Git LFS preference + * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability * is powered by [Git LFS](https://git-lfs.com). * * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ readonly patch: operations["migrations/set-lfs-preference"]; @@ -9871,7 +10257,8 @@ export type paths = { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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["issues/create"]; readonly delete?: never; @@ -10120,9 +10507,8 @@ 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. - * See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" - * and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" - * for details. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/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["issues/create-comment"]; readonly delete?: never; @@ -10767,6 +11153,27 @@ export type paths = { 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; + }; + /** + * 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; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/pulls": { readonly parameters: { readonly query?: never; @@ -10786,7 +11193,7 @@ export type paths = { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * 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/overview/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/create"]; readonly delete?: never; @@ -10975,7 +11382,8 @@ export type paths = { * * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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/create-review-comment"]; readonly delete?: never; @@ -10997,7 +11405,8 @@ export type paths = { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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/create-reply-for-review-comment"]; readonly delete?: never; @@ -11061,7 +11470,7 @@ export type paths = { /** * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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; @@ -11087,7 +11496,7 @@ export type paths = { /** * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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"]; /** @@ -11115,7 +11524,7 @@ export type paths = { readonly put?: never; /** * Create a review for a pull request - * @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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * @@ -11301,7 +11710,7 @@ export type paths = { * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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; @@ -12540,7 +12949,7 @@ export type paths = { }; /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12579,7 +12988,7 @@ export type paths = { }; /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match * metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -12606,7 +13015,7 @@ export type paths = { }; /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -12637,7 +13046,7 @@ export type paths = { }; /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12665,7 +13074,7 @@ export type paths = { }; /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12693,7 +13102,7 @@ export type paths = { }; /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12721,7 +13130,7 @@ export type paths = { }; /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12804,7 +13213,7 @@ export type paths = { * * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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["teams/create-discussion-legacy"]; readonly delete?: never; @@ -12873,7 +13282,7 @@ export type paths = { * * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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["teams/create-discussion-comment-legacy"]; readonly delete?: never; @@ -13394,7 +13803,7 @@ export type paths = { }; /** * List secrets for the authenticated user - * @description Lists all secrets available for a user's Codespaces without revealing their + * @description Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -13443,7 +13852,7 @@ export type paths = { }; /** * Get a secret for the authenticated user - * @description Gets a secret available to a user's codespaces without revealing its encrypted value. + * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13452,7 +13861,7 @@ export type paths = { readonly get: operations["codespaces/get-secret-for-authenticated-user"]; /** * Create or update a secret for the authenticated user - * @description Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -13463,7 +13872,7 @@ export type paths = { readonly post?: never; /** * Delete a secret for the authenticated user - * @description Deletes a 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. + * @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. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13484,7 +13893,7 @@ export type paths = { }; /** * List selected repositories for a user secret - * @description List the repositories that have been granted the ability to use a user's codespace secret. + * @description List the repositories that have been granted the ability to use a user's development environment secret. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13493,7 +13902,7 @@ export type paths = { readonly 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 codespace secret. + * @description Select the repositories that will use a user's development environment secret. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13517,7 +13926,7 @@ export type paths = { readonly get?: never; /** * Add a selected repository to a user secret - * @description Adds a repository to the selected repositories for a user's codespace secret. + * @description Adds a repository to the selected repositories for a user's development environment secret. * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. */ @@ -13525,7 +13934,7 @@ export type paths = { readonly post?: never; /** * Remove a selected repository from a user secret - * @description Removes a repository from the selected repositories for a user's codespace secret. + * @description Removes a repository from the selected repositories for a user's development environment secret. * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. */ @@ -16333,6 +16742,11 @@ export type components = { * @enum {string} */ readonly organization_custom_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom property management. + * @enum {string} + */ + readonly organization_custom_properties?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} @@ -17487,10 +17901,7 @@ export type components = { * * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - * - * [homepage]: http://contributor-covenant.org - * [version]: http://contributor-covenant.org/version/1/4/ + * 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; /** Format: uri */ @@ -17952,6 +18363,11 @@ export type components = { readonly push_protection_bypassed_at?: string | null; /** @description The comment that was optionally added when this alert was closed */ readonly resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + readonly validity?: "active" | "inactive" | "unknown"; }; /** * Actor @@ -19739,8 +20155,8 @@ export type components = { readonly version?: components["schemas"]["code-scanning-analysis-tool-version"]; readonly guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** @description The full Git reference, formatted as `refs/heads/`, - * `refs/pull//merge`, or `refs/pull//head`. */ + /** @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. */ readonly "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; @@ -20048,8 +20464,8 @@ export type components = { readonly created_at?: string; }; /** - * Copilot for Business Seat Breakdown - * @description The breakdown of Copilot for Business seats for the organization. + * Copilot Business Seat Breakdown + * @description The breakdown of Copilot Business seats for the organization. */ readonly "copilot-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ @@ -20066,8 +20482,8 @@ export type components = { readonly inactive_this_cycle?: number; }; /** - * Copilot for Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot for Business subscription. + * Copilot Business Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. */ readonly "copilot-organization-details": { readonly seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -20263,8 +20679,8 @@ export type components = { }; }; /** - * Copilot for Business Seat Detail - * @description Information about a Copilot for Business seat assignment for a user, team, or organization. + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ readonly "copilot-seat-details": { /** @description The assignee that has been granted access to GitHub Copilot. */ @@ -20773,6 +21189,39 @@ export type components = { /** @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?: string[]; }; + /** + * Organization Fine-Grained Permission + * @description A fine-grained permission that protects organization resources. + */ + readonly "organization-fine-grained-permission": { + readonly name: string; + readonly description: string; + }; + /** + * Organization Role + * @description Organization roles + */ + readonly "organization-role": { + /** @description The unique identifier of the role. */ + readonly id: number; + /** @description The name of the role. */ + readonly name: string; + /** @description A short description about who this role is for or what permissions it grants. */ + readonly description?: string | null; + /** @description A list of permissions included in this role. */ + readonly permissions: string[]; + readonly organization: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The date and time the role was created. + */ + readonly created_at: string; + /** + * Format: date-time + * @description The date and time the role was last updated. + */ + readonly updated_at: string; + }; /** * Package Version * @description A version of a software package @@ -20968,6 +21417,52 @@ export type components = { /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ readonly private?: boolean; }; + /** + * Organization Custom Property + * @description Custom property defined on an organization + */ + readonly "org-custom-property": { + /** @description The name of the property */ + readonly property_name: string; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + readonly value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + readonly required?: boolean; + /** @description Default value of the property */ + readonly default_value?: string | null; + /** @description Short description of the property */ + readonly description?: string | null; + /** @description Ordered list of allowed values of the property */ + readonly allowed_values?: string[] | null; + }; + /** + * Custom Property Value + * @description Custom property name and associated value + */ + readonly "custom-property-value": { + /** @description The name of the property */ + readonly property_name: string; + /** @description The value assigned to the property */ + readonly value: string | null; + }; + /** + * Organization Repository Custom Property Values + * @description List of custom property values for a repository + */ + readonly "org-repo-custom-property-values": { + /** @example 1296269 */ + readonly repository_id: number; + /** @example Hello-World */ + readonly repository_name: string; + /** @example octocat/Hello-World */ + readonly repository_full_name: string; + /** @description List of custom property names and associated values */ + readonly properties: components["schemas"]["custom-property-value"][]; + }; /** * @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} @@ -20978,7 +21473,7 @@ export type components = { * @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 */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ readonly actor_id: number; /** * @description The type of actor that can bypass a ruleset @@ -21071,7 +21566,7 @@ export type components = { }; /** * required_deployments - * @description Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule. + * @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": { /** @enum {string} */ @@ -21121,7 +21616,7 @@ export type components = { }; /** * required_status_checks - * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed. + * @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": { /** @enum {string} */ @@ -21246,11 +21741,37 @@ export type components = { readonly pattern: string; }; }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + readonly "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + readonly path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + readonly ref?: string; + /** @description The ID of the repository where the workflow is defined */ + readonly repository_id: number; + /** @description The commit SHA of the workflow file to use */ + readonly 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": { + /** @enum {string} */ + readonly type: "workflows"; + readonly parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; /** * Repository Rule * @description A repository rule. */ - 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-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"]; + 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-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-workflows"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -21429,7 +21950,10 @@ export type components = { readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ readonly cve_id: string | null; - /** @description The API URL for the advisory. */ + /** + * Format: uri + * @description The API URL for the advisory. + */ readonly url: string; /** * Format: uri @@ -21899,7 +22423,7 @@ export type components = { */ readonly pinned: boolean; /** - * @description Whether or not this discussion should be restricted to team members and organization administrators. + * @description Whether or not this discussion should be restricted to team members and organization owners. * @example true */ readonly private: boolean; @@ -22050,10 +22574,10 @@ export type components = { }; }; /** - * Repository - * @description A repository on GitHub. + * Team Repository + * @description A team's access to a repository. */ - readonly "nullable-repository": { + readonly "team-repository": { /** * @description Unique identifier of the repository * @example 42 @@ -22069,7 +22593,6 @@ export type components = { /** @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; @@ -22078,7 +22601,9 @@ export type components = { readonly push: boolean; readonly maintain?: boolean; }; - readonly owner: components["schemas"]["simple-user"]; + /** @example admin */ + readonly role_name?: string; + readonly owner: components["schemas"]["nullable-simple-user"]; /** * @description Whether the repository is private or public. * @default false @@ -22236,10 +22761,7 @@ export type components = { readonly stargazers_count: number; /** @example 80 */ readonly watchers_count: number; - /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 - */ + /** @example 108 */ readonly size: number; /** * @description The default branch of the repository. @@ -22275,18 +22797,11 @@ export type components = { readonly has_wiki: boolean; readonly has_pages: boolean; /** - * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ readonly has_downloads: boolean; - /** - * @description Whether discussions are enabled. - * @default false - * @example true - */ - readonly has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -22320,150 +22835,6 @@ export type components = { * @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?: 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; - /** - * @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"; - /** - * @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} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "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"; - /** - * @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} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - } | null; readonly temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -22484,79 +22855,164 @@ export type components = { */ readonly 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. + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow forking this repo * @default false * @example false */ - readonly allow_update_branch: boolean; + readonly allow_forking: boolean; /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether to require contributors to sign off on web-based commits * @default false + * @example false */ - readonly use_squash_pr_title_as_default: boolean; + 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": { /** - * @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} + * Format: uri + * @example https://api.github.com/projects/columns/cards/1478 */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly url: string; /** - * @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} + * @description The project card's ID + * @example 42 */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + 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"]; /** - * @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} + * Format: date-time + * @example 2016-09-05T14:21:06Z */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly created_at: 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} + * Format: date-time + * @example 2016-09-05T14:20:22Z */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly updated_at: string; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true + * @description Whether or not the card is archived + * @example false */ - readonly allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + readonly archived?: boolean; + readonly column_name?: string; + readonly project_id?: string; /** - * @description Whether to require contributors to sign off on web-based commits - * @default false + * Format: uri + * @example https://api.github.com/projects/columns/367 */ - 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; - /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; - } | null; + 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; + }; /** - * Team Repository - * @description A team's access to a repository. + * Project Column + * @description Project columns contain cards of work. */ - readonly "team-repository": { + 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"]; + }; + /** Rate Limit */ + readonly "rate-limit": { + readonly limit: number; + readonly remaining: number; + readonly reset: number; + readonly 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 rate: components["schemas"]["rate-limit"]; + }; + /** + * Repository + * @description A repository on GitHub. + */ + readonly "nullable-repository": { /** * @description Unique identifier of the repository * @example 42 @@ -22572,6 +23028,7 @@ export type components = { /** @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; @@ -22580,9 +23037,7 @@ export type components = { readonly push: boolean; readonly maintain?: boolean; }; - /** @example admin */ - readonly role_name?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false @@ -22740,7 +23195,10 @@ export type components = { readonly stargazers_count: number; /** @example 80 */ readonly watchers_count: number; - /** @example 108 */ + /** + * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 + */ readonly size: number; /** * @description The default branch of the repository. @@ -22776,11 +23234,18 @@ export type components = { readonly has_wiki: boolean; readonly has_pages: boolean; /** + * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ readonly has_downloads: boolean; + /** + * @description Whether discussions are enabled. + * @default false + * @example true + */ + readonly has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -22814,7 +23279,150 @@ export type components = { * @example true */ readonly allow_rebase_merge: boolean; - readonly template_repository?: components["schemas"]["nullable-repository"]; + 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?: 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; + /** + * @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"; + /** + * @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} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "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"; + /** + * @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} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly allow_merge_commit?: boolean; + readonly subscribers_count?: number; + readonly network_count?: number; + } | null; readonly temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -22835,159 +23443,74 @@ export type components = { */ readonly delete_branch_on_merge: boolean; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow forking this repo + * @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_forking: boolean; + readonly allow_update_branch: boolean; /** - * @description Whether to require contributors to sign off on web-based commits + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @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; - /** - * @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; + readonly use_squash_pr_title_as_default: boolean; /** - * Format: uri - * @example https://api.github.com/projects/120 + * @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 project_url: string; + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards + * @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} */ - readonly cards_url: string; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The unique identifier of the project column - * @example 42 + * @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 id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - readonly node_id: string; + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Name of the project column - * @example Remaining tasks + * @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} */ - readonly name: string; + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** - * Format: date-time - * @example 2016-09-05T14:18:44Z + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true */ - readonly created_at: string; + readonly allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + readonly allow_forking?: boolean; /** - * Format: date-time - * @example 2016-09-05T14:22:28Z + * @description Whether to require contributors to sign off on web-based commits + * @default false */ - 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"]; - }; - /** Rate Limit */ - readonly "rate-limit": { - readonly limit: number; - readonly remaining: number; - readonly reset: number; - readonly 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 rate: components["schemas"]["rate-limit"]; - }; + 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; + /** @example "2020-07-09T00:17:42Z" */ + readonly starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + readonly anonymous_access_enabled?: boolean; + } | null; /** * Code Of Conduct Simple * @description Code of Conduct Simple @@ -23428,7 +23951,7 @@ export type components = { * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: "queued" | "in_progress" | "completed" | "waiting"; /** * @description The outcome of the job. * @example success @@ -25082,7 +25605,7 @@ export type components = { * @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; - /** @description The commit SHA of the CodeQL databases repository at time of database creation. */ + /** @description The commit SHA of the repository at the time the CodeQL database was created. */ readonly commit_oid?: string | null; }; /** @description Configuration for code scanning default setup. */ @@ -25114,10 +25637,10 @@ export type components = { /** @description Configuration for code scanning default setup. */ readonly "code-scanning-default-setup-update": { /** - * @description Whether code scanning default setup has been configured or not. + * @description The desired state of code scanning default setup. * @enum {string} */ - readonly state: "configured" | "not-configured"; + readonly state?: "configured" | "not-configured"; /** * @description CodeQL query suite to be used. * @enum {string} @@ -25134,6 +25657,12 @@ export type components = { /** @description URL of the corresponding run. */ readonly run_url?: string; }; + /** + * @description The full Git reference, formatted as `refs/heads/`, + * `refs/pull//merge`, or `refs/pull//head`. + * @example refs/heads/main + */ + readonly "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": { @@ -26555,32 +27084,44 @@ export type components = { readonly "prevent-self-review": boolean; /** * Deployment branch policy - * @description Details of a deployment branch policy. + * @description Details of a deployment branch or tag policy. */ readonly "deployment-branch-policy": { /** - * @description The unique identifier of the branch policy. + * @description The unique identifier of the branch or tag policy. * @example 361471 */ readonly id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ readonly node_id?: string; /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ readonly name?: string; + /** + * @description Whether this rule targets a branch or tag. + * @example branch + * @enum {string} + */ + readonly type?: "branch" | "tag"; }; - /** Deployment branch policy name pattern */ + /** Deployment branch and tag policy name pattern */ readonly "deployment-branch-policy-name-pattern-with-type": { /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. * 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; + /** + * @description Whether this rule targets a branch or tag + * @example branch + * @enum {string} + */ + readonly type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ readonly "deployment-branch-policy-name-pattern": { @@ -29112,7 +29653,7 @@ export type components = { * 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-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"]); + 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-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"]); readonly "secret-scanning-alert": { readonly number?: components["schemas"]["alert-number"]; readonly created_at?: components["schemas"]["alert-created-at"]; @@ -29149,6 +29690,11 @@ export type components = { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + readonly validity?: "active" | "inactive" | "unknown"; }; /** @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; @@ -30783,6 +31329,10 @@ export type components = { */ readonly is_template: boolean; readonly 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; + }; /** * @description Whether issues are enabled. * @default true @@ -31615,6 +32165,10 @@ export type components = { */ readonly is_template: boolean; readonly 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; + }; /** * @description Whether issues are enabled. * @default true @@ -33885,6 +34439,53 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; + /** custom property created event */ + readonly "webhook-custom-property-created": { + /** @enum {string} */ + readonly action: "created"; + readonly definition: components["schemas"]["org-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-webhooks"]; + }; + /** custom property deleted event */ + readonly "webhook-custom-property-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly definition: { + /** @description The name of the property that was deleted. */ + readonly 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-webhooks"]; + }; + /** custom property updated event */ + readonly "webhook-custom-property-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly definition: components["schemas"]["org-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-webhooks"]; + }; + /** Custom property values updated event */ + readonly "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-webhooks"]; + /** @description The new custom property values for the repository. */ + readonly new_property_values: components["schemas"]["custom-property-value"][]; + /** @description The old custom property values for the repository. */ + readonly old_property_values: components["schemas"]["custom-property-value"][]; + }; /** delete event */ readonly "webhook-delete": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -37263,6 +37864,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -44204,6 +44809,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -46170,6 +46779,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -82923,6 +83536,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -86675,6 +87292,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -86984,6 +87605,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -87293,6 +87918,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -87633,6 +88262,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -87942,6 +88575,10 @@ export type components = { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -90666,6 +91303,8 @@ export type components = { 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 The unique identifier of the gist. */ readonly "gist-id": string; /** @description The unique identifier of the comment. */ @@ -90722,6 +91361,10 @@ export type components = { readonly "migration-id": number; /** @description repo_name parameter */ readonly "repo-name": string; + /** @description The slug of the team name. */ + readonly "team-slug": string; + /** @description The unique identifier of the role. */ + readonly "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`. @@ -90747,6 +91390,8 @@ export type components = { readonly "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ readonly "fine-grained-personal-access-token-id": number; + /** @description The custom property name. The name is case sensitive. */ + readonly "custom-property-name": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly "repository-name-in-query": number; /** @description The time period to filter by. @@ -90766,8 +91411,6 @@ export type components = { readonly "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; - /** @description The slug of the team name. */ - readonly "team-slug": string; /** @description The number that identifies the discussion. */ readonly "discussion-number": number; /** @description The number that identifies the comment. */ @@ -91907,6 +92550,8 @@ export interface operations { 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. */ 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"]; }; readonly header?: never; readonly path: { @@ -95477,7 +96122,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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: { headers: { readonly [name: string]: unknown; @@ -95520,7 +96165,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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: { headers: { readonly [name: string]: unknown; @@ -95563,7 +96208,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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: { headers: { readonly [name: string]: unknown; @@ -95606,7 +96251,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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: { headers: { readonly [name: string]: unknown; @@ -96890,7 +97535,7 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/get-copilot-seat-assignment-details-for-user": { + readonly "copilot/get-copilot-seat-details-for-user": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -96916,7 +97561,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business is not enabled for this organization or the user has a pending organization invitation. */ + /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -97261,6 +97906,451 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; + readonly "orgs/list-organization-fine-grained-permissions": { + 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: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["organization-fine-grained-permission"][]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/list-org-roles": { + 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: { + /** @description Response - list of organization roles */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description The total number of organization roles available to the organization. */ + readonly total_count?: number; + /** @description The list of organization roles available to the organization. */ + readonly roles?: components["schemas"]["organization-role"][]; + }; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/create-custom-organization-role": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the custom role. */ + readonly name: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + readonly description?: string; + /** @description A list of additional permissions included in this role. */ + readonly permissions: string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["organization-role"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/revoke-all-org-roles-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; + }; + content?: never; + }; + }; + }; + readonly "orgs/assign-team-to-org-role": { + 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 role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization, team or role does not exist. */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/revoke-org-role-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"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/revoke-all-org-roles-user": { + 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 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 "orgs/assign-user-to-org-role": { + 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 handle for the GitHub user account. */ + readonly username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization, user or role does not exist. */ + readonly 404: { + headers: { + readonly [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: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/revoke-org-role-user": { + 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 handle for the GitHub user account. */ + readonly username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/get-org-role": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["organization-role"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/delete-custom-organization-role": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/patch-custom-organization-role": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the custom role. */ + readonly name?: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + readonly description?: string; + /** @description A list of additional permissions included in this role. */ + readonly permissions?: string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["organization-role"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/list-org-role-teams": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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 unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response - List of assigned teams */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["team"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/list-org-role-users": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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 unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response - List of assigned users */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["simple-user"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; readonly "orgs/list-outside-collaborators": { readonly parameters: { readonly query?: { @@ -97986,6 +99076,220 @@ export interface operations { readonly 422: components["responses"]["validation_failed_simple"]; }; }; + readonly "orgs/get-all-custom-properties": { + 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: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/create-or-update-custom-properties": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The array of custom properties to create or update. */ + readonly properties: components["schemas"]["org-custom-property"][]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/get-custom-property": { + 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 custom property name. The name is case sensitive. */ + readonly custom_property_name: components["parameters"]["custom-property-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-custom-property"]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/create-or-update-custom-property": { + 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 custom property name. The name is case sensitive. */ + readonly custom_property_name: components["parameters"]["custom-property-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + readonly value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + readonly required?: boolean; + /** @description Default value of the property */ + readonly default_value?: string | null; + /** @description Short description of the property */ + readonly description?: string | null; + /** @description Ordered list of allowed values of the property */ + readonly allowed_values?: string[] | null; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-custom-property"]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/remove-custom-property": { + 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 custom property name. The name is case sensitive. */ + readonly custom_property_name: components["parameters"]["custom-property-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 204: components["responses"]["no_content"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/list-custom-properties-values-for-repos": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + readonly 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; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 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: { + /** @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 The names of repositories that the custom property values will be applied to. */ + readonly repository_names: string[]; + /** @description List of custom property names and associated values to apply to the repositories. */ + readonly properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + readonly responses: { + /** @description No Content when custom property values are successfully created or updated */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "orgs/list-public-members": { readonly parameters: { readonly query?: { @@ -98258,6 +99562,10 @@ export interface operations { * @enum {string} */ readonly 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; + }; }; }; }; @@ -98542,6 +99850,8 @@ export interface operations { 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"]; }; readonly header?: never; readonly path: { @@ -105741,7 +107051,7 @@ export interface operations { readonly content: { readonly "application/json": { readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - readonly ref: components["schemas"]["code-scanning-ref"]; + readonly ref: components["schemas"]["code-scanning-ref-full"]; readonly sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** * Format: uri @@ -111501,6 +112811,7 @@ export interface operations { readonly "application/json": components["schemas"]["license-content"]; }; }; + readonly 404: components["responses"]["not_found"]; }; }; readonly "repos/merge-upstream": { @@ -112378,6 +113689,33 @@ export interface operations { 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": components["schemas"]["custom-property-value"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "pulls/list": { readonly parameters: { readonly query?: { @@ -114612,6 +115950,8 @@ export interface operations { 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"]; }; readonly header?: never; readonly path: { diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index 4355f2584..de4eab409 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -724,7 +724,7 @@ export interface paths { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * 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; @@ -2274,8 +2274,6 @@ export interface paths { * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * For public repositories, you may instead use the `public_repo` scope. - * - * GitHub Apps must have the `security_events` read permission to use this endpoint. */ readonly get: operations["code-scanning/list-alerts-for-org"]; readonly put?: never; @@ -2297,7 +2295,7 @@ export interface paths { * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. */ readonly get: operations["codespaces/list-in-organization"]; readonly put?: never; @@ -2320,7 +2318,7 @@ export interface paths { * 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. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ readonly put: operations["codespaces/set-codespaces-access"]; readonly post?: never; @@ -2347,7 +2345,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ readonly post: operations["codespaces/set-codespaces-access-users"]; /** @@ -2358,7 +2356,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ readonly delete: operations["codespaces/delete-codespaces-access-users"]; readonly options?: never; @@ -2375,7 +2373,7 @@ export interface paths { }; /** * List organization secrets - * @description Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. + * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/list-org-secrets"]; @@ -2416,13 +2414,13 @@ export interface paths { }; /** * Get an organization secret - * @description Gets an organization secret without revealing its encrypted value. + * @description Gets an organization development environment secret without revealing its encrypted value. * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/get-org-secret"]; /** * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * You must authenticate using an access @@ -2432,7 +2430,7 @@ export interface paths { readonly post?: never; /** * Delete an organization secret - * @description Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-org-secret"]; readonly options?: never; @@ -2454,7 +2452,7 @@ export interface paths { readonly get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/set-selected-repos-for-org-secret"]; readonly post?: never; @@ -2474,13 +2472,13 @@ export interface paths { readonly get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @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). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/add-selected-repo-to-org-secret"]; readonly post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/remove-selected-repo-from-org-secret"]; readonly options?: never; @@ -2496,14 +2494,14 @@ export interface paths { readonly cookie?: never; }; /** - * Get Copilot for Business seat information and settings for an organization + * Get Copilot Business seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot for Business subscription, including seat breakdown + * Gets information about an organization's Copilot Business subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/get-copilot-organization-details"]; @@ -2523,12 +2521,12 @@ export interface paths { readonly cookie?: never; }; /** - * List all Copilot for Business seat assignments for an organization + * List all Copilot Business seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/list-copilot-seats"]; @@ -2550,30 +2548,30 @@ export interface paths { readonly get?: never; readonly put?: never; /** - * Add teams to the Copilot for Business subscription for an organization + * Add teams to the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot for Business seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Purchases a GitHub Copilot Business seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. * - * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". */ readonly post: operations["copilot/add-copilot-for-business-seats-for-teams"]; /** - * Remove teams from the Copilot for Business subscription for an organization + * Remove teams from the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for all members of each team specified. + * Cancels the Copilot Business seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -2594,30 +2592,30 @@ export interface paths { readonly get?: never; readonly put?: never; /** - * Add users to the Copilot for Business subscription for an organization + * Add users to the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot for Business seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Purchases a GitHub Copilot Business seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. * - * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". */ readonly post: operations["copilot/add-copilot-for-business-seats-for-users"]; /** - * Remove users from the Copilot for Business subscription for an organization + * Remove users from the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for each user specified. + * Cancels the Copilot Business seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -3074,7 +3072,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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; @@ -3205,7 +3204,7 @@ export interface paths { * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. */ readonly get: operations["codespaces/get-codespaces-for-user-in-org"]; readonly put?: never; @@ -3230,7 +3229,10 @@ export interface paths { * Delete a codespace from the organization * @description Deletes a user's codespace. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * To use this endpoint you must authenticate using one of the following methods: + * + * - An access token with the `admin:org` scope + * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` */ readonly delete: operations["codespaces/delete-from-organization"]; readonly options?: never; @@ -3251,7 +3253,10 @@ export interface paths { * Stop a codespace for an organization user * @description Stops a user's codespace. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * To use this endpoint you must authenticate using one of the following methods: + * + * - An access token with the `admin:org` scope + * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` */ readonly post: operations["codespaces/stop-in-organization"]; readonly delete?: never; @@ -3268,14 +3273,14 @@ export interface paths { readonly cookie?: never; }; /** - * Get Copilot for Business seat assignment details for a user + * Get Copilot Business seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - readonly get: operations["copilot/get-copilot-seat-assignment-details-for-user"]; + readonly get: operations["copilot/get-copilot-seat-details-for-user"]; readonly put?: never; readonly post?: never; readonly delete?: never; @@ -3439,6 +3444,306 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/organization-fine-grained-permissions": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List organization fine-grained permissions for an organization + * @description **Note**: This operation is in beta and subject to change. + * + * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + */ + readonly get: operations["orgs/list-organization-fine-grained-permissions"]; + 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": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get all organization roles for an organization + * @description Lists the organization roles available in this organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly get: operations["orgs/list-org-roles"]; + readonly put?: never; + /** + * Create a custom organization role + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly post: operations["orgs/create-custom-organization-role"]; + 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; + /** + * Remove all organization roles for a team + * @description Removes all assigned organization roles from a team. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/revoke-all-org-roles-team"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly 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; + }; + readonly get?: never; + /** + * Assign an organization role to a team + * @description Assigns an organization role to a team in an organization. + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly put: operations["orgs/assign-team-to-org-role"]; + readonly post?: never; + /** + * Remove an organization role from a team + * @description Removes an organization role from a team. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/revoke-org-role-team"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/organization-roles/users/{username}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + readonly post?: never; + /** + * Remove all organization roles for a user + * @description Revokes all assigned organization roles from a user. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/revoke-all-org-roles-user"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly 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; + }; + readonly get?: never; + /** + * Assign an organization role to a user + * @description Assigns an organization role to a member of an organization. + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly put: operations["orgs/assign-user-to-org-role"]; + readonly post?: never; + /** + * Remove an organization role from a user + * @description Remove an organization role from a user. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/revoke-org-role-user"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/organization-roles/{role_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get an organization role + * @description Gets an organization role that is available to this organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly get: operations["orgs/get-org-role"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a custom organization role. + * @description Deletes a custom organization role. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly delete: operations["orgs/delete-custom-organization-role"]; + readonly options?: never; + readonly head?: never; + /** + * Update a custom organization role + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + readonly patch: operations["orgs/patch-custom-organization-role"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/organization-roles/{role_id}/teams": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List teams that are assigned to an organization role + * @description Lists the teams that are assigned to an organization role. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + 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; + }; + readonly "/orgs/{org}/organization-roles/{role_id}/users": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List users that are assigned to an organization role + * @description Lists organization members that are assigned to an organization role. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + 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; + }; readonly "/orgs/{org}/outside_collaborators": { readonly parameters: { readonly query?: never; @@ -3819,6 +4124,95 @@ export interface paths { 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; + }; + /** + * Get all custom properties for an organization + * @description Gets all custom properties defined for an organization. + * You must be an organization owner to use this endpoint. + */ + readonly get: operations["orgs/get-all-custom-properties"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly 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. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + readonly patch: operations["orgs/create-or-update-custom-properties"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/properties/schema/{custom_property_name}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a custom property for an organization + * @description Gets a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + readonly get: operations["orgs/get-custom-property"]; + /** + * 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. + * You must be an organization owner to use this endpoint. + */ + readonly put: operations["orgs/create-or-update-custom-property"]; + readonly post?: never; + /** + * Remove a custom property for an organization + * @description Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + readonly delete: operations["orgs/remove-custom-property"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/properties/values": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly 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; + /** + * 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. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + readonly patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + readonly trace?: never; + }; readonly "/orgs/{org}/public_members": { readonly parameters: { readonly query?: never; @@ -4251,7 +4645,7 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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`. */ @@ -4315,7 +4709,7 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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`. */ @@ -4650,6 +5044,8 @@ export interface paths { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * + * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ readonly get: operations["teams/check-permissions-for-repo-in-org"]; @@ -7159,9 +7555,6 @@ export interface paths { * * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. * - * GitHub Apps must have the `security_events` read - * permission to use this endpoint. - * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if you used `ref` in the request). @@ -7184,7 +7577,7 @@ export interface paths { }; /** * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. */ readonly get: operations["code-scanning/get-alert"]; readonly put?: never; @@ -7194,7 +7587,7 @@ export interface paths { readonly head?: never; /** * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. */ readonly patch: operations["code-scanning/update-alert"]; readonly trace?: never; @@ -7211,7 +7604,6 @@ export interface paths { * @description Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. */ readonly get: operations["code-scanning/list-alert-instances"]; readonly put?: never; @@ -7244,7 +7636,6 @@ export interface paths { * * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. @@ -7270,7 +7661,6 @@ export interface paths { * @description Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -7377,7 +7767,6 @@ export interface paths { * * For private repositories, you must use an access token with the `security_events` scope. * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. */ readonly get: operations["code-scanning/list-codeql-databases"]; readonly put?: never; @@ -7407,7 +7796,6 @@ export interface paths { * * For private repositories, you must use an access token with the `security_events` scope. * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. */ readonly get: operations["code-scanning/get-codeql-database"]; readonly put?: never; @@ -7429,7 +7817,7 @@ export interface paths { * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * scope for public repos. */ readonly get: operations["code-scanning/get-default-setup"]; readonly put?: never; @@ -7441,7 +7829,7 @@ export interface paths { * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * scope for public repos. */ readonly patch: operations["code-scanning/update-default-setup"]; readonly trace?: never; @@ -7504,7 +7892,7 @@ export interface paths { }; /** * 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)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @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)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. */ readonly get: operations["code-scanning/get-sarif"]; readonly put?: never; @@ -7677,7 +8065,7 @@ export interface paths { }; /** * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ readonly get: operations["codespaces/list-repo-secrets"]; readonly put?: never; @@ -7717,12 +8105,12 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ readonly get: operations["codespaces/get-repo-secret"]; /** * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * @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)." * * You must authenticate using an access @@ -7733,7 +8121,7 @@ export interface paths { readonly post?: never; /** * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ readonly delete: operations["codespaces/delete-repo-secret"]; readonly options?: never; @@ -7788,7 +8176,7 @@ export interface paths { readonly 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -8041,7 +8429,7 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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-commit-comment"]; readonly delete?: never; @@ -8848,7 +9236,7 @@ export interface paths { readonly put?: never; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -8868,14 +9256,14 @@ export interface paths { }; /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ readonly get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -8883,7 +9271,7 @@ export interface paths { readonly post?: never; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -9580,11 +9968,10 @@ export interface paths { }; /** * Get an import status + * @deprecated * @description View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -9622,18 +10009,22 @@ export interface paths { readonly get: operations["migrations/get-import-status"]; /** * Start an import - * @description Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * @deprecated + * @description Start a source import to a GitHub repository using GitHub Importer. + * Importing into a GitHub repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * */ readonly put: operations["migrations/start-import"]; readonly post?: never; /** * Cancel an import + * @deprecated * @description Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ readonly delete: operations["migrations/cancel-import"]; @@ -9641,6 +10032,7 @@ export interface paths { readonly head?: never; /** * Update an import + * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. * @@ -9648,9 +10040,7 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly patch: operations["migrations/update-import"]; readonly trace?: never; @@ -9664,13 +10054,12 @@ export interface paths { }; /** * Get commit authors + * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ readonly get: operations["migrations/get-commit-authors"]; readonly put?: never; @@ -9696,12 +10085,11 @@ export interface paths { readonly head?: never; /** * Map a commit author + * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ readonly patch: operations["migrations/map-commit-author"]; @@ -9716,11 +10104,10 @@ export interface paths { }; /** * Get large files + * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ readonly get: operations["migrations/get-large-files"]; @@ -9747,15 +10134,14 @@ export interface paths { readonly head?: never; /** * Update Git LFS preference + * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability * is powered by [Git LFS](https://git-lfs.com). * * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ readonly patch: operations["migrations/set-lfs-preference"]; @@ -9871,7 +10257,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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["issues/create"]; readonly delete?: never; @@ -10120,9 +10507,8 @@ 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. - * See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" - * and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" - * for details. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/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["issues/create-comment"]; readonly delete?: never; @@ -10767,6 +11153,27 @@ export interface paths { 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; + }; + /** + * 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; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/pulls": { readonly parameters: { readonly query?: never; @@ -10786,7 +11193,7 @@ export interface paths { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * 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/overview/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/create"]; readonly delete?: never; @@ -10975,7 +11382,8 @@ export interface paths { * * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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/create-review-comment"]; readonly delete?: never; @@ -10997,7 +11405,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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/create-reply-for-review-comment"]; readonly delete?: never; @@ -11061,7 +11470,7 @@ export interface paths { /** * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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; @@ -11087,7 +11496,7 @@ export interface paths { /** * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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"]; /** @@ -11115,7 +11524,7 @@ export interface paths { readonly put?: never; /** * Create a review for a pull request - * @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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * @@ -11301,7 +11710,7 @@ export interface paths { * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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; @@ -12540,7 +12949,7 @@ export interface paths { }; /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12579,7 +12988,7 @@ export interface paths { }; /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match * metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -12606,7 +13015,7 @@ export interface paths { }; /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -12637,7 +13046,7 @@ export interface paths { }; /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12665,7 +13074,7 @@ export interface paths { }; /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12693,7 +13102,7 @@ export interface paths { }; /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12721,7 +13130,7 @@ export interface paths { }; /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12804,7 +13213,7 @@ export interface paths { * * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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["teams/create-discussion-legacy"]; readonly delete?: never; @@ -12873,7 +13282,7 @@ export interface paths { * * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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["teams/create-discussion-comment-legacy"]; readonly delete?: never; @@ -13394,7 +13803,7 @@ export interface paths { }; /** * List secrets for the authenticated user - * @description Lists all secrets available for a user's Codespaces without revealing their + * @description Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -13443,7 +13852,7 @@ export interface paths { }; /** * Get a secret for the authenticated user - * @description Gets a secret available to a user's codespaces without revealing its encrypted value. + * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13452,7 +13861,7 @@ export interface paths { readonly get: operations["codespaces/get-secret-for-authenticated-user"]; /** * Create or update a secret for the authenticated user - * @description Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -13463,7 +13872,7 @@ export interface paths { readonly post?: never; /** * Delete a secret for the authenticated user - * @description Deletes a 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. + * @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. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13484,7 +13893,7 @@ export interface paths { }; /** * List selected repositories for a user secret - * @description List the repositories that have been granted the ability to use a user's codespace secret. + * @description List the repositories that have been granted the ability to use a user's development environment secret. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13493,7 +13902,7 @@ export interface paths { readonly 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 codespace secret. + * @description Select the repositories that will use a user's development environment secret. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13517,7 +13926,7 @@ export interface paths { readonly get?: never; /** * Add a selected repository to a user secret - * @description Adds a repository to the selected repositories for a user's codespace secret. + * @description Adds a repository to the selected repositories for a user's development environment secret. * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. */ @@ -13525,7 +13934,7 @@ export interface paths { readonly post?: never; /** * Remove a selected repository from a user secret - * @description Removes a repository from the selected repositories for a user's codespace secret. + * @description Removes a repository from the selected repositories for a user's development environment secret. * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. */ @@ -16333,6 +16742,11 @@ export interface components { * @enum {string} */ readonly organization_custom_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom property management. + * @enum {string} + */ + readonly organization_custom_properties?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} @@ -17487,10 +17901,7 @@ export interface components { * * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - * - * [homepage]: http://contributor-covenant.org - * [version]: http://contributor-covenant.org/version/1/4/ + * 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; /** Format: uri */ @@ -17952,6 +18363,11 @@ export interface components { readonly push_protection_bypassed_at?: string | null; /** @description The comment that was optionally added when this alert was closed */ readonly resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + readonly validity?: "active" | "inactive" | "unknown"; }; /** * Actor @@ -19739,8 +20155,8 @@ export interface components { readonly version?: components["schemas"]["code-scanning-analysis-tool-version"]; readonly guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** @description The full Git reference, formatted as `refs/heads/`, - * `refs/pull//merge`, or `refs/pull//head`. */ + /** @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. */ readonly "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; @@ -20048,8 +20464,8 @@ export interface components { readonly created_at?: string; }; /** - * Copilot for Business Seat Breakdown - * @description The breakdown of Copilot for Business seats for the organization. + * Copilot Business Seat Breakdown + * @description The breakdown of Copilot Business seats for the organization. */ readonly "copilot-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ @@ -20066,8 +20482,8 @@ export interface components { readonly inactive_this_cycle?: number; }; /** - * Copilot for Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot for Business subscription. + * Copilot Business Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. */ readonly "copilot-organization-details": { readonly seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -20263,8 +20679,8 @@ export interface components { }; }; /** - * Copilot for Business Seat Detail - * @description Information about a Copilot for Business seat assignment for a user, team, or organization. + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ readonly "copilot-seat-details": { /** @description The assignee that has been granted access to GitHub Copilot. */ @@ -20773,6 +21189,39 @@ export interface components { /** @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?: string[]; }; + /** + * Organization Fine-Grained Permission + * @description A fine-grained permission that protects organization resources. + */ + readonly "organization-fine-grained-permission": { + readonly name: string; + readonly description: string; + }; + /** + * Organization Role + * @description Organization roles + */ + readonly "organization-role": { + /** @description The unique identifier of the role. */ + readonly id: number; + /** @description The name of the role. */ + readonly name: string; + /** @description A short description about who this role is for or what permissions it grants. */ + readonly description?: string | null; + /** @description A list of permissions included in this role. */ + readonly permissions: string[]; + readonly organization: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The date and time the role was created. + */ + readonly created_at: string; + /** + * Format: date-time + * @description The date and time the role was last updated. + */ + readonly updated_at: string; + }; /** * Package Version * @description A version of a software package @@ -20968,6 +21417,52 @@ export interface components { /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ readonly private?: boolean; }; + /** + * Organization Custom Property + * @description Custom property defined on an organization + */ + readonly "org-custom-property": { + /** @description The name of the property */ + readonly property_name: string; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + readonly value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + readonly required?: boolean; + /** @description Default value of the property */ + readonly default_value?: string | null; + /** @description Short description of the property */ + readonly description?: string | null; + /** @description Ordered list of allowed values of the property */ + readonly allowed_values?: string[] | null; + }; + /** + * Custom Property Value + * @description Custom property name and associated value + */ + readonly "custom-property-value": { + /** @description The name of the property */ + readonly property_name: string; + /** @description The value assigned to the property */ + readonly value: string | null; + }; + /** + * Organization Repository Custom Property Values + * @description List of custom property values for a repository + */ + readonly "org-repo-custom-property-values": { + /** @example 1296269 */ + readonly repository_id: number; + /** @example Hello-World */ + readonly repository_name: string; + /** @example octocat/Hello-World */ + readonly repository_full_name: string; + /** @description List of custom property names and associated values */ + readonly properties: components["schemas"]["custom-property-value"][]; + }; /** * @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} @@ -20978,7 +21473,7 @@ export interface components { * @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 */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ readonly actor_id: number; /** * @description The type of actor that can bypass a ruleset @@ -21071,7 +21566,7 @@ export interface components { }; /** * required_deployments - * @description Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule. + * @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": { /** @enum {string} */ @@ -21121,7 +21616,7 @@ export interface components { }; /** * required_status_checks - * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed. + * @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": { /** @enum {string} */ @@ -21246,11 +21741,37 @@ export interface components { readonly pattern: string; }; }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + readonly "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + readonly path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + readonly ref?: string; + /** @description The ID of the repository where the workflow is defined */ + readonly repository_id: number; + /** @description The commit SHA of the workflow file to use */ + readonly 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": { + /** @enum {string} */ + readonly type: "workflows"; + readonly parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; /** * Repository Rule * @description A repository rule. */ - 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-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"]; + 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-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-workflows"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -21429,7 +21950,10 @@ export interface components { readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ readonly cve_id: string | null; - /** @description The API URL for the advisory. */ + /** + * Format: uri + * @description The API URL for the advisory. + */ readonly url: string; /** * Format: uri @@ -21899,7 +22423,7 @@ export interface components { */ readonly pinned: boolean; /** - * @description Whether or not this discussion should be restricted to team members and organization administrators. + * @description Whether or not this discussion should be restricted to team members and organization owners. * @example true */ readonly private: boolean; @@ -22050,10 +22574,10 @@ export interface components { }; }; /** - * Repository - * @description A repository on GitHub. + * Team Repository + * @description A team's access to a repository. */ - readonly "nullable-repository": { + readonly "team-repository": { /** * @description Unique identifier of the repository * @example 42 @@ -22069,7 +22593,6 @@ export interface components { /** @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; @@ -22078,7 +22601,9 @@ export interface components { readonly push: boolean; readonly maintain?: boolean; }; - readonly owner: components["schemas"]["simple-user"]; + /** @example admin */ + readonly role_name?: string; + readonly owner: components["schemas"]["nullable-simple-user"]; /** * @description Whether the repository is private or public. * @default false @@ -22236,10 +22761,7 @@ export interface components { readonly stargazers_count: number; /** @example 80 */ readonly watchers_count: number; - /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 - */ + /** @example 108 */ readonly size: number; /** * @description The default branch of the repository. @@ -22275,18 +22797,11 @@ export interface components { readonly has_wiki: boolean; readonly has_pages: boolean; /** - * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ readonly has_downloads: boolean; - /** - * @description Whether discussions are enabled. - * @default false - * @example true - */ - readonly has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -22320,150 +22835,6 @@ export interface components { * @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?: 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; - /** - * @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"; - /** - * @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} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "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"; - /** - * @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} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - } | null; readonly temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -22484,79 +22855,164 @@ export interface components { */ readonly 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. + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow forking this repo * @default false * @example false */ - readonly allow_update_branch: boolean; + readonly allow_forking: boolean; /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether to require contributors to sign off on web-based commits * @default false + * @example false */ - readonly use_squash_pr_title_as_default: boolean; + 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": { /** - * @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} + * Format: uri + * @example https://api.github.com/projects/columns/cards/1478 */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly url: string; /** - * @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} + * @description The project card's ID + * @example 42 */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + 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"]; /** - * @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} + * Format: date-time + * @example 2016-09-05T14:21:06Z */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly created_at: 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} + * Format: date-time + * @example 2016-09-05T14:20:22Z */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly updated_at: string; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true + * @description Whether or not the card is archived + * @example false */ - readonly allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + readonly archived?: boolean; + readonly column_name?: string; + readonly project_id?: string; /** - * @description Whether to require contributors to sign off on web-based commits - * @default false + * Format: uri + * @example https://api.github.com/projects/columns/367 */ - 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; - /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; - } | null; + 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; + }; /** - * Team Repository - * @description A team's access to a repository. + * Project Column + * @description Project columns contain cards of work. */ - readonly "team-repository": { + 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"]; + }; + /** Rate Limit */ + readonly "rate-limit": { + readonly limit: number; + readonly remaining: number; + readonly reset: number; + readonly 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 rate: components["schemas"]["rate-limit"]; + }; + /** + * Repository + * @description A repository on GitHub. + */ + readonly "nullable-repository": { /** * @description Unique identifier of the repository * @example 42 @@ -22572,6 +23028,7 @@ export interface components { /** @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; @@ -22580,9 +23037,7 @@ export interface components { readonly push: boolean; readonly maintain?: boolean; }; - /** @example admin */ - readonly role_name?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false @@ -22740,7 +23195,10 @@ export interface components { readonly stargazers_count: number; /** @example 80 */ readonly watchers_count: number; - /** @example 108 */ + /** + * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 + */ readonly size: number; /** * @description The default branch of the repository. @@ -22776,11 +23234,18 @@ export interface components { readonly has_wiki: boolean; readonly has_pages: boolean; /** + * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ readonly has_downloads: boolean; + /** + * @description Whether discussions are enabled. + * @default false + * @example true + */ + readonly has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -22814,7 +23279,150 @@ export interface components { * @example true */ readonly allow_rebase_merge: boolean; - readonly template_repository?: components["schemas"]["nullable-repository"]; + 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?: 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; + /** + * @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"; + /** + * @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} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "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"; + /** + * @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} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly allow_merge_commit?: boolean; + readonly subscribers_count?: number; + readonly network_count?: number; + } | null; readonly temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -22835,159 +23443,74 @@ export interface components { */ readonly delete_branch_on_merge: boolean; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow forking this repo + * @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_forking: boolean; + readonly allow_update_branch: boolean; /** - * @description Whether to require contributors to sign off on web-based commits + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @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; - /** - * @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; + readonly use_squash_pr_title_as_default: boolean; /** - * Format: uri - * @example https://api.github.com/projects/120 + * @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 project_url: string; + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards + * @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} */ - readonly cards_url: string; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The unique identifier of the project column - * @example 42 + * @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 id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - readonly node_id: string; + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Name of the project column - * @example Remaining tasks + * @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} */ - readonly name: string; + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** - * Format: date-time - * @example 2016-09-05T14:18:44Z + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true */ - readonly created_at: string; + readonly allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + readonly allow_forking?: boolean; /** - * Format: date-time - * @example 2016-09-05T14:22:28Z + * @description Whether to require contributors to sign off on web-based commits + * @default false */ - 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"]; - }; - /** Rate Limit */ - readonly "rate-limit": { - readonly limit: number; - readonly remaining: number; - readonly reset: number; - readonly 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 rate: components["schemas"]["rate-limit"]; - }; + 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; + /** @example "2020-07-09T00:17:42Z" */ + readonly starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + readonly anonymous_access_enabled?: boolean; + } | null; /** * Code Of Conduct Simple * @description Code of Conduct Simple @@ -23428,7 +23951,7 @@ export interface components { * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: "queued" | "in_progress" | "completed" | "waiting"; /** * @description The outcome of the job. * @example success @@ -25082,7 +25605,7 @@ export interface components { * @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; - /** @description The commit SHA of the CodeQL databases repository at time of database creation. */ + /** @description The commit SHA of the repository at the time the CodeQL database was created. */ readonly commit_oid?: string | null; }; /** @description Configuration for code scanning default setup. */ @@ -25114,10 +25637,10 @@ export interface components { /** @description Configuration for code scanning default setup. */ readonly "code-scanning-default-setup-update": { /** - * @description Whether code scanning default setup has been configured or not. + * @description The desired state of code scanning default setup. * @enum {string} */ - readonly state: "configured" | "not-configured"; + readonly state?: "configured" | "not-configured"; /** * @description CodeQL query suite to be used. * @enum {string} @@ -25134,6 +25657,12 @@ export interface components { /** @description URL of the corresponding run. */ readonly run_url?: string; }; + /** + * @description The full Git reference, formatted as `refs/heads/`, + * `refs/pull//merge`, or `refs/pull//head`. + * @example refs/heads/main + */ + readonly "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": { @@ -26555,32 +27084,44 @@ export interface components { readonly "prevent-self-review": boolean; /** * Deployment branch policy - * @description Details of a deployment branch policy. + * @description Details of a deployment branch or tag policy. */ readonly "deployment-branch-policy": { /** - * @description The unique identifier of the branch policy. + * @description The unique identifier of the branch or tag policy. * @example 361471 */ readonly id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ readonly node_id?: string; /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ readonly name?: string; + /** + * @description Whether this rule targets a branch or tag. + * @example branch + * @enum {string} + */ + readonly type?: "branch" | "tag"; }; - /** Deployment branch policy name pattern */ + /** Deployment branch and tag policy name pattern */ readonly "deployment-branch-policy-name-pattern-with-type": { /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. * 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; + /** + * @description Whether this rule targets a branch or tag + * @example branch + * @enum {string} + */ + readonly type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ readonly "deployment-branch-policy-name-pattern": { @@ -29112,7 +29653,7 @@ export interface components { * 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-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"]); + 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-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"]); readonly "secret-scanning-alert": { readonly number?: components["schemas"]["alert-number"]; readonly created_at?: components["schemas"]["alert-created-at"]; @@ -29149,6 +29690,11 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly push_protection_bypassed_at?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + readonly validity?: "active" | "inactive" | "unknown"; }; /** @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; @@ -30783,6 +31329,10 @@ export interface components { */ readonly is_template: boolean; readonly 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; + }; /** * @description Whether issues are enabled. * @default true @@ -31615,6 +32165,10 @@ export interface components { */ readonly is_template: boolean; readonly 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; + }; /** * @description Whether issues are enabled. * @default true @@ -33885,6 +34439,53 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; + /** custom property created event */ + readonly "webhook-custom-property-created": { + /** @enum {string} */ + readonly action: "created"; + readonly definition: components["schemas"]["org-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-webhooks"]; + }; + /** custom property deleted event */ + readonly "webhook-custom-property-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly definition: { + /** @description The name of the property that was deleted. */ + readonly 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-webhooks"]; + }; + /** custom property updated event */ + readonly "webhook-custom-property-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly definition: components["schemas"]["org-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-webhooks"]; + }; + /** Custom property values updated event */ + readonly "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-webhooks"]; + /** @description The new custom property values for the repository. */ + readonly new_property_values: components["schemas"]["custom-property-value"][]; + /** @description The old custom property values for the repository. */ + readonly old_property_values: components["schemas"]["custom-property-value"][]; + }; /** delete event */ readonly "webhook-delete": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -37263,6 +37864,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -44204,6 +44809,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -46170,6 +46779,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -82923,6 +83536,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -86675,6 +87292,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -86984,6 +87605,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -87293,6 +87918,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -87633,6 +88262,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -87942,6 +88575,10 @@ export interface components { /** Format: uri */ readonly contributors_url: string; readonly 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; + }; /** @description The default branch of the repository. */ readonly default_branch: string; /** @@ -90666,6 +91303,8 @@ export interface components { 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 The unique identifier of the gist. */ readonly "gist-id": string; /** @description The unique identifier of the comment. */ @@ -90722,6 +91361,10 @@ export interface components { readonly "migration-id": number; /** @description repo_name parameter */ readonly "repo-name": string; + /** @description The slug of the team name. */ + readonly "team-slug": string; + /** @description The unique identifier of the role. */ + readonly "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`. @@ -90747,6 +91390,8 @@ export interface components { readonly "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ readonly "fine-grained-personal-access-token-id": number; + /** @description The custom property name. The name is case sensitive. */ + readonly "custom-property-name": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ readonly "repository-name-in-query": number; /** @description The time period to filter by. @@ -90766,8 +91411,6 @@ export interface components { readonly "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; - /** @description The slug of the team name. */ - readonly "team-slug": string; /** @description The number that identifies the discussion. */ readonly "discussion-number": number; /** @description The number that identifies the comment. */ @@ -91907,6 +92550,8 @@ export interface operations { 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. */ 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"]; }; readonly header?: never; readonly path: { @@ -95477,7 +96122,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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: { headers: { readonly [name: string]: unknown; @@ -95520,7 +96165,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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: { headers: { readonly [name: string]: unknown; @@ -95563,7 +96208,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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: { headers: { readonly [name: string]: unknown; @@ -95606,7 +96251,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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: { headers: { readonly [name: string]: unknown; @@ -96890,7 +97535,7 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/get-copilot-seat-assignment-details-for-user": { + readonly "copilot/get-copilot-seat-details-for-user": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -96916,7 +97561,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot for Business is not enabled for this organization or the user has a pending organization invitation. */ + /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -97261,6 +97906,451 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; + readonly "orgs/list-organization-fine-grained-permissions": { + 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: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["organization-fine-grained-permission"][]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/list-org-roles": { + 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: { + /** @description Response - list of organization roles */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + /** @description The total number of organization roles available to the organization. */ + readonly total_count?: number; + /** @description The list of organization roles available to the organization. */ + readonly roles?: components["schemas"]["organization-role"][]; + }; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/create-custom-organization-role": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the custom role. */ + readonly name: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + readonly description?: string; + /** @description A list of additional permissions included in this role. */ + readonly permissions: string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["organization-role"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/revoke-all-org-roles-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; + }; + content?: never; + }; + }; + }; + readonly "orgs/assign-team-to-org-role": { + 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 role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization, team or role does not exist. */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/revoke-org-role-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"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/revoke-all-org-roles-user": { + 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 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 "orgs/assign-user-to-org-role": { + 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 handle for the GitHub user account. */ + readonly username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization, user or role does not exist. */ + readonly 404: { + headers: { + readonly [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: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/revoke-org-role-user": { + 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 handle for the GitHub user account. */ + readonly username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/get-org-role": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["organization-role"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/delete-custom-organization-role": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/patch-custom-organization-role": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the custom role. */ + readonly name?: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + readonly description?: string; + /** @description A list of additional permissions included in this role. */ + readonly permissions?: string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["organization-role"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "orgs/list-org-role-teams": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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 unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response - List of assigned teams */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["team"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "orgs/list-org-role-users": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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 unique identifier of the role. */ + readonly role_id: components["parameters"]["role-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response - List of assigned users */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["simple-user"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + readonly 404: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; readonly "orgs/list-outside-collaborators": { readonly parameters: { readonly query?: { @@ -97986,6 +99076,220 @@ export interface operations { readonly 422: components["responses"]["validation_failed_simple"]; }; }; + readonly "orgs/get-all-custom-properties": { + 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: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/create-or-update-custom-properties": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The array of custom properties to create or update. */ + readonly properties: components["schemas"]["org-custom-property"][]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/get-custom-property": { + 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 custom property name. The name is case sensitive. */ + readonly custom_property_name: components["parameters"]["custom-property-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-custom-property"]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/create-or-update-custom-property": { + 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 custom property name. The name is case sensitive. */ + readonly custom_property_name: components["parameters"]["custom-property-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + readonly value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + readonly required?: boolean; + /** @description Default value of the property */ + readonly default_value?: string | null; + /** @description Short description of the property */ + readonly description?: string | null; + /** @description Ordered list of allowed values of the property */ + readonly allowed_values?: string[] | null; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-custom-property"]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/remove-custom-property": { + 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 custom property name. The name is case sensitive. */ + readonly custom_property_name: components["parameters"]["custom-property-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + readonly 204: components["responses"]["no_content"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "orgs/list-custom-properties-values-for-repos": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + readonly 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; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 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: { + /** @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 The names of repositories that the custom property values will be applied to. */ + readonly repository_names: string[]; + /** @description List of custom property names and associated values to apply to the repositories. */ + readonly properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + readonly responses: { + /** @description No Content when custom property values are successfully created or updated */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "orgs/list-public-members": { readonly parameters: { readonly query?: { @@ -98258,6 +99562,10 @@ export interface operations { * @enum {string} */ readonly 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; + }; }; }; }; @@ -98542,6 +99850,8 @@ export interface operations { 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"]; }; readonly header?: never; readonly path: { @@ -105741,7 +107051,7 @@ export interface operations { readonly content: { readonly "application/json": { readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - readonly ref: components["schemas"]["code-scanning-ref"]; + readonly ref: components["schemas"]["code-scanning-ref-full"]; readonly sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** * Format: uri @@ -111501,6 +112811,7 @@ export interface operations { readonly "application/json": components["schemas"]["license-content"]; }; }; + readonly 404: components["responses"]["not_found"]; }; }; readonly "repos/merge-upstream": { @@ -112378,6 +113689,33 @@ export interface operations { 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": components["schemas"]["custom-property-value"][]; + }; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + }; + }; readonly "pulls/list": { readonly parameters: { readonly query?: { @@ -114612,6 +115950,8 @@ export interface operations { 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"]; }; readonly header?: never; readonly path: { diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index 55131a4bd..c747b2f78 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -724,7 +724,7 @@ export interface paths { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * 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. */ get: operations["gists/list-public"]; put?: never; @@ -2274,8 +2274,6 @@ export interface paths { * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * For public repositories, you may instead use the `public_repo` scope. - * - * GitHub Apps must have the `security_events` read permission to use this endpoint. */ get: operations["code-scanning/list-alerts-for-org"]; put?: never; @@ -2297,7 +2295,7 @@ export interface paths { * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. */ get: operations["codespaces/list-in-organization"]; put?: never; @@ -2320,7 +2318,7 @@ export interface paths { * 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. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ put: operations["codespaces/set-codespaces-access"]; post?: never; @@ -2347,7 +2345,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ post: operations["codespaces/set-codespaces-access-users"]; /** @@ -2358,7 +2356,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ delete: operations["codespaces/delete-codespaces-access-users"]; options?: never; @@ -2375,7 +2373,7 @@ export interface paths { }; /** * List organization secrets - * @description Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. + * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-org-secrets"]; @@ -2416,13 +2414,13 @@ export interface paths { }; /** * Get an organization secret - * @description Gets an organization secret without revealing its encrypted value. + * @description Gets an organization development environment secret without revealing its encrypted value. * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-secret"]; /** * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * You must authenticate using an access @@ -2432,7 +2430,7 @@ export interface paths { post?: never; /** * Delete an organization secret - * @description Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-org-secret"]; options?: never; @@ -2454,7 +2452,7 @@ export interface paths { get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-selected-repos-for-org-secret"]; post?: never; @@ -2474,13 +2472,13 @@ export interface paths { get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @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). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ 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 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). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/remove-selected-repo-from-org-secret"]; options?: never; @@ -2496,14 +2494,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot for Business seat information and settings for an organization + * Get Copilot Business seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot for Business subscription, including seat breakdown + * Gets information about an organization's Copilot Business subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; @@ -2523,12 +2521,12 @@ export interface paths { cookie?: never; }; /** - * List all Copilot for Business seat assignments for an organization + * List all Copilot Business seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; @@ -2550,30 +2548,30 @@ export interface paths { get?: never; put?: never; /** - * Add teams to the Copilot for Business subscription for an organization + * Add teams to the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot for Business seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Purchases a GitHub Copilot Business seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. * - * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". */ post: operations["copilot/add-copilot-for-business-seats-for-teams"]; /** - * Remove teams from the Copilot for Business subscription for an organization + * Remove teams from the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for all members of each team specified. + * Cancels the Copilot Business seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -2594,30 +2592,30 @@ export interface paths { get?: never; put?: never; /** - * Add users to the Copilot for Business subscription for an organization + * Add users to the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot for Business seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Purchases a GitHub Copilot Business seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. * - * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". */ post: operations["copilot/add-copilot-for-business-seats-for-users"]; /** - * Remove users from the Copilot for Business subscription for an organization + * Remove users from the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for each user specified. + * Cancels the Copilot Business seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -3074,7 +3072,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["orgs/create-invitation"]; delete?: never; @@ -3205,7 +3204,7 @@ export interface paths { * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. */ get: operations["codespaces/get-codespaces-for-user-in-org"]; put?: never; @@ -3230,7 +3229,10 @@ export interface paths { * Delete a codespace from the organization * @description Deletes a user's codespace. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * To use this endpoint you must authenticate using one of the following methods: + * + * - An access token with the `admin:org` scope + * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` */ delete: operations["codespaces/delete-from-organization"]; options?: never; @@ -3251,7 +3253,10 @@ export interface paths { * Stop a codespace for an organization user * @description Stops a user's codespace. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * To use this endpoint you must authenticate using one of the following methods: + * + * - An access token with the `admin:org` scope + * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` */ post: operations["codespaces/stop-in-organization"]; delete?: never; @@ -3268,14 +3273,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot for Business seat assignment details for a user + * Get Copilot Business seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - get: operations["copilot/get-copilot-seat-assignment-details-for-user"]; + get: operations["copilot/get-copilot-seat-details-for-user"]; put?: never; post?: never; delete?: never; @@ -3439,6 +3444,306 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/organization-fine-grained-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List organization fine-grained permissions for an organization + * @description **Note**: This operation is in beta and subject to change. + * + * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all organization roles for an organization + * @description Lists the organization roles available in this organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + get: operations["orgs/list-org-roles"]; + put?: never; + /** + * Create a custom organization role + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + post: operations["orgs/create-custom-organization-role"]; + 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. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/revoke-all-org-roles-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Assign an organization role to a team + * @description Assigns an organization role to a team in an organization. + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + 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. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/revoke-org-role-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove all organization roles for a user + * @description Revokes all assigned organization roles from a user. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/revoke-all-org-roles-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Assign an organization role to a user + * @description Assigns an organization role to a member of an organization. + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + 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. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/revoke-org-role-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an organization role + * @description Gets an organization role that is available to this organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + get: operations["orgs/get-org-role"]; + put?: never; + post?: never; + /** + * Delete a custom organization role. + * @description Deletes a custom organization role. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/delete-custom-organization-role"]; + options?: never; + head?: never; + /** + * Update a custom organization role + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + patch: operations["orgs/patch-custom-organization-role"]; + trace?: 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 + * @description Lists the teams that are assigned to an organization role. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + get: operations["orgs/list-org-role-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: 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 + * @description Lists organization members that are assigned to an organization role. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + get: operations["orgs/list-org-role-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/outside_collaborators": { parameters: { query?: never; @@ -3819,6 +4124,95 @@ export interface paths { 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. + * You must be an organization owner to use this endpoint. + */ + get: operations["orgs/get-all-custom-properties"]; + 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. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + patch: operations["orgs/create-or-update-custom-properties"]; + trace?: 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. + * You must be an organization owner to use this endpoint. + */ + get: operations["orgs/get-custom-property"]; + /** + * 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. + * You must be an organization owner to use this endpoint. + */ + put: operations["orgs/create-or-update-custom-property"]; + post?: never; + /** + * Remove a custom property for an organization + * @description Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + delete: operations["orgs/remove-custom-property"]; + options?: never; + head?: never; + patch?: never; + trace?: 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. + */ + get: operations["orgs/list-custom-properties-values-for-repos"]; + 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. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + trace?: never; + }; "/orgs/{org}/public_members": { parameters: { query?: never; @@ -4251,7 +4645,7 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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`. */ @@ -4315,7 +4709,7 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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`. */ @@ -4650,6 +5044,8 @@ export interface paths { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * + * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; @@ -7159,9 +7555,6 @@ export interface paths { * * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. * - * GitHub Apps must have the `security_events` read - * permission to use this endpoint. - * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if you used `ref` in the request). @@ -7184,7 +7577,7 @@ export interface paths { }; /** * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. */ get: operations["code-scanning/get-alert"]; put?: never; @@ -7194,7 +7587,7 @@ export interface paths { head?: never; /** * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. */ patch: operations["code-scanning/update-alert"]; trace?: never; @@ -7211,7 +7604,6 @@ export interface paths { * @description Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. */ get: operations["code-scanning/list-alert-instances"]; put?: never; @@ -7244,7 +7636,6 @@ export interface paths { * * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. @@ -7270,7 +7661,6 @@ export interface paths { * @description Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -7377,7 +7767,6 @@ export interface paths { * * For private repositories, you must use an access token with the `security_events` scope. * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. */ get: operations["code-scanning/list-codeql-databases"]; put?: never; @@ -7407,7 +7796,6 @@ export interface paths { * * For private repositories, you must use an access token with the `security_events` scope. * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. */ get: operations["code-scanning/get-codeql-database"]; put?: never; @@ -7429,7 +7817,7 @@ export interface paths { * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * scope for public repos. */ get: operations["code-scanning/get-default-setup"]; put?: never; @@ -7441,7 +7829,7 @@ export interface paths { * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * scope for public repos. */ patch: operations["code-scanning/update-default-setup"]; trace?: never; @@ -7504,7 +7892,7 @@ export interface paths { }; /** * 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)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @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)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. */ get: operations["code-scanning/get-sarif"]; put?: never; @@ -7677,7 +8065,7 @@ export interface paths { }; /** * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ get: operations["codespaces/list-repo-secrets"]; put?: never; @@ -7717,12 +8105,12 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ get: operations["codespaces/get-repo-secret"]; /** * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * @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)." * * You must authenticate using an access @@ -7733,7 +8121,7 @@ export interface paths { post?: never; /** * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ delete: operations["codespaces/delete-repo-secret"]; options?: never; @@ -7788,7 +8176,7 @@ 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -8041,7 +8429,7 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["repos/create-commit-comment"]; delete?: never; @@ -8848,7 +9236,7 @@ export interface paths { put?: never; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -8868,14 +9256,14 @@ export interface paths { }; /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -8883,7 +9271,7 @@ export interface paths { post?: never; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -9580,11 +9968,10 @@ export interface paths { }; /** * Get an import status + * @deprecated * @description View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -9622,18 +10009,22 @@ export interface paths { get: operations["migrations/get-import-status"]; /** * Start an import - * @description Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * @deprecated + * @description Start a source import to a GitHub repository using GitHub Importer. + * Importing into a GitHub repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * */ put: operations["migrations/start-import"]; post?: never; /** * Cancel an import + * @deprecated * @description Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ delete: operations["migrations/cancel-import"]; @@ -9641,6 +10032,7 @@ export interface paths { head?: never; /** * Update an import + * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. * @@ -9648,9 +10040,7 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -9664,13 +10054,12 @@ export interface paths { }; /** * Get commit authors + * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -9696,12 +10085,11 @@ export interface paths { head?: never; /** * Map a commit author + * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ patch: operations["migrations/map-commit-author"]; @@ -9716,11 +10104,10 @@ export interface paths { }; /** * Get large files + * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ get: operations["migrations/get-large-files"]; @@ -9747,15 +10134,14 @@ export interface paths { head?: never; /** * Update Git LFS preference + * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability * is powered by [Git LFS](https://git-lfs.com). * * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ patch: operations["migrations/set-lfs-preference"]; @@ -9871,7 +10257,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["issues/create"]; delete?: never; @@ -10120,9 +10507,8 @@ 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. - * See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" - * and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" - * for details. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/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)." */ post: operations["issues/create-comment"]; delete?: never; @@ -10767,6 +11153,27 @@ export interface paths { patch?: never; trace?: 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. + */ + get: operations["repos/get-custom-properties-values"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/pulls": { parameters: { query?: never; @@ -10786,7 +11193,7 @@ export interface paths { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * 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/overview/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)." */ post: operations["pulls/create"]; delete?: never; @@ -10975,7 +11382,8 @@ export interface paths { * * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["pulls/create-review-comment"]; delete?: never; @@ -10997,7 +11405,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["pulls/create-reply-for-review-comment"]; delete?: never; @@ -11061,7 +11470,7 @@ export interface paths { /** * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ put: operations["pulls/merge"]; post?: never; @@ -11087,7 +11496,7 @@ export interface paths { /** * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["pulls/request-reviewers"]; /** @@ -11115,7 +11524,7 @@ export interface paths { put?: never; /** * Create a review for a pull request - * @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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * @@ -11301,7 +11710,7 @@ export interface paths { * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["repos/create-release"]; delete?: never; @@ -12540,7 +12949,7 @@ export interface paths { }; /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12579,7 +12988,7 @@ export interface paths { }; /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match * metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -12606,7 +13015,7 @@ export interface paths { }; /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -12637,7 +13046,7 @@ export interface paths { }; /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12665,7 +13074,7 @@ export interface paths { }; /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12693,7 +13102,7 @@ export interface paths { }; /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12721,7 +13130,7 @@ export interface paths { }; /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12804,7 +13213,7 @@ export interface paths { * * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["teams/create-discussion-legacy"]; delete?: never; @@ -12873,7 +13282,7 @@ export interface paths { * * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["teams/create-discussion-comment-legacy"]; delete?: never; @@ -13394,7 +13803,7 @@ export interface paths { }; /** * List secrets for the authenticated user - * @description Lists all secrets available for a user's Codespaces without revealing their + * @description Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -13443,7 +13852,7 @@ export interface paths { }; /** * Get a secret for the authenticated user - * @description Gets a secret available to a user's codespaces without revealing its encrypted value. + * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13452,7 +13861,7 @@ export interface paths { get: operations["codespaces/get-secret-for-authenticated-user"]; /** * Create or update a secret for the authenticated user - * @description Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -13463,7 +13872,7 @@ export interface paths { post?: never; /** * Delete a secret for the authenticated user - * @description Deletes a 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. + * @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. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13484,7 +13893,7 @@ export interface paths { }; /** * List selected repositories for a user secret - * @description List the repositories that have been granted the ability to use a user's codespace secret. + * @description List the repositories that have been granted the ability to use a user's development environment secret. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13493,7 +13902,7 @@ export interface paths { 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 codespace secret. + * @description Select the repositories that will use a user's development environment secret. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13517,7 +13926,7 @@ export interface paths { get?: never; /** * Add a selected repository to a user secret - * @description Adds a repository to the selected repositories for a user's codespace secret. + * @description Adds a repository to the selected repositories for a user's development environment secret. * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. */ @@ -13525,7 +13934,7 @@ export interface paths { post?: never; /** * Remove a selected repository from a user secret - * @description Removes a repository from the selected repositories for a user's codespace secret. + * @description Removes a repository from the selected repositories for a user's development environment secret. * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. */ @@ -16002,6 +16411,102 @@ export interface webhooks { patch?: never; trace?: never; }; + "custom-property-created": { + 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 new custom property was created. + */ + post: operations["custom-property/created"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "custom-property-deleted": { + 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 deleted. + */ + post: operations["custom-property/deleted"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "custom-property-updated": { + 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 updated. + */ + post: operations["custom-property/updated"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "custom-property-values-updated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to custom property values for a repository. + * + * 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. + * + * 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. + */ + post: operations["custom-property-values/updated"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; delete: { parameters: { query?: never; @@ -19218,7 +19723,7 @@ export interface 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 The title or body of a pull request was edited. + * @description The title or body of a pull request was edited, or the base branch of a pull request was changed. */ post: operations["pull-request/edited"]; delete?: never; @@ -20207,7 +20712,7 @@ export interface webhooks { * 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 "Administration" repository permission. + * 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. */ post: operations["repository-ruleset/created"]; @@ -20231,7 +20736,7 @@ export interface webhooks { * 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 "Administration" repository permission. + * 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. */ post: operations["repository-ruleset/deleted"]; @@ -20255,7 +20760,7 @@ export interface webhooks { * 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 "Administration" repository permission. + * 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. */ post: operations["repository-ruleset/edited"]; @@ -21735,6 +22240,11 @@ export interface components { * @enum {string} */ organization_custom_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom property management. + * @enum {string} + */ + organization_custom_properties?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} @@ -22869,6 +23379,11 @@ export interface components { push_protection_bypassed_at?: 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"; }; /** * Actor @@ -24058,8 +24573,8 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** @description The full Git reference, formatted as `refs/heads/`, - * `refs/pull//merge`, or `refs/pull//head`. */ + /** @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; @@ -24290,8 +24805,8 @@ export interface components { created_at?: string; }; /** - * Copilot for Business Seat Breakdown - * @description The breakdown of Copilot for Business seats for the organization. + * Copilot Business Seat Breakdown + * @description The breakdown of Copilot Business seats for the organization. */ "copilot-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ @@ -24308,8 +24823,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot for Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot for Business subscription. + * Copilot Business Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -24456,8 +24971,8 @@ export interface components { }; }; /** - * Copilot for Business Seat Detail - * @description Information about a Copilot for Business seat assignment for a user, team, or organization. + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { /** @description The assignee that has been granted access to GitHub Copilot. */ @@ -24670,6 +25185,39 @@ export interface components { /** @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"`. */ exclude?: string[]; }; + /** + * Organization Fine-Grained Permission + * @description A fine-grained permission that protects organization resources. + */ + "organization-fine-grained-permission": { + name: string; + description: string; + }; + /** + * Organization Role + * @description Organization roles + */ + "organization-role": { + /** @description The unique identifier of the role. */ + id: number; + /** @description The name of the role. */ + name: string; + /** @description A short description about who this role is for or what permissions it grants. */ + description?: string | null; + /** @description A list of permissions included in this role. */ + permissions: string[]; + organization: null | components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The date and time the role was created. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the role was last updated. + */ + updated_at: string; + }; /** * Package Version * @description A version of a software package @@ -24813,6 +25361,48 @@ export interface components { /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ private?: boolean; }; + /** + * Organization Custom Property + * @description Custom property defined on an organization + */ + "org-custom-property": { + /** @description The name of the property */ + property_name: string; + /** + * @description The type of the value for the property + * @enum {string} + */ + value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | null; + /** @description Short description of the property */ + description?: string | null; + /** @description Ordered list of allowed values of the property */ + allowed_values?: string[] | null; + }; + /** + * Custom Property Value + * @description Custom property name and associated value + */ + "custom-property-value": { + /** @description The name of the property */ + property_name: string; + /** @description The value assigned to the property */ + value: string | null; + }; + /** + * Organization Repository Custom Property Values + * @description List of custom property values for a repository + */ + "org-repo-custom-property-values": { + repository_id: number; + repository_name: string; + repository_full_name: string; + /** @description List of custom property names and associated values */ + properties: components["schemas"]["custom-property-value"][]; + }; /** * @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} @@ -24823,7 +25413,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 */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ actor_id: number; /** * @description The type of actor that can bypass a ruleset @@ -24916,7 +25506,7 @@ export interface components { }; /** * required_deployments - * @description Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule. + * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. */ "repository-rule-required-deployments": { /** @enum {string} */ @@ -24966,7 +25556,7 @@ export interface components { }; /** * required_status_checks - * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed. + * @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. */ "repository-rule-required-status-checks": { /** @enum {string} */ @@ -25091,11 +25681,37 @@ export interface components { pattern: string; }; }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + ref?: string; + /** @description The ID of the repository where the workflow is defined */ + repository_id: number; + /** @description The commit SHA of the workflow file to use */ + sha?: string; + }; + /** + * workflows + * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + */ + "repository-rule-workflows": { + /** @enum {string} */ + type: "workflows"; + parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; /** * 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-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": 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-workflows"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -25268,8 +25884,11 @@ export interface components { readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ cve_id: string | null; - /** @description The API URL for the advisory. */ - url: string; + /** + * Format: uri + * @description The API URL for the advisory. + */ + readonly url: string; /** * Format: uri * @description The URL for the advisory. @@ -25556,7 +26175,7 @@ export interface components { number: number; /** @description Whether or not this discussion should be pinned for easy retrieval. */ pinned: boolean; - /** @description Whether or not this discussion should be restricted to team members and organization administrators. */ + /** @description Whether or not this discussion should be restricted to team members and organization owners. */ private: boolean; /** Format: uri */ team_url: string; @@ -25808,7 +26427,6 @@ export interface components { * @default true */ allow_rebase_merge: boolean; - template_repository?: null | components["schemas"]["repository"]; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -26182,7 +26800,7 @@ export interface components { * @description The phase of the lifecycle that the job is currently in. * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed" | "waiting"; /** * @description The outcome of the job. * @enum {string|null} @@ -27349,7 +27967,7 @@ export interface components { * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. */ url: string; - /** @description The commit SHA of the CodeQL databases repository at time of database creation. */ + /** @description The commit SHA of the repository at the time the CodeQL database was created. */ commit_oid?: string | null; }; /** @description Configuration for code scanning default setup. */ @@ -27380,10 +27998,10 @@ export interface components { /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup-update": { /** - * @description Whether code scanning default setup has been configured or not. + * @description The desired state of code scanning default setup. * @enum {string} */ - state: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** * @description CodeQL query suite to be used. * @enum {string} @@ -27400,6 +28018,9 @@ export interface components { /** @description URL of the corresponding run. */ run_url?: string; }; + /** @description The full Git reference, formatted as `refs/heads/`, + * `refs/pull//merge`, or `refs/pull//head`. */ + "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)." */ "code-scanning-analysis-sarif-file": string; "code-scanning-sarifs-receipt": { @@ -28369,22 +28990,32 @@ export interface components { "prevent-self-review": boolean; /** * Deployment branch policy - * @description Details of a deployment branch policy. + * @description Details of a deployment branch or tag policy. */ "deployment-branch-policy": { - /** @description The unique identifier of the branch policy. */ + /** @description The unique identifier of the branch or tag policy. */ id?: number; node_id?: string; - /** @description The name pattern that branches must match in order to deploy to the environment. */ + /** @description The name pattern that branches or tags must match in order to deploy to the environment. */ name?: string; + /** + * @description Whether this rule targets a branch or tag. + * @enum {string} + */ + type?: "branch" | "tag"; }; - /** Deployment branch policy name pattern */ + /** Deployment branch and tag policy name pattern */ "deployment-branch-policy-name-pattern-with-type": { - /** @description The name pattern that branches must match in order to deploy to the environment. + /** @description The name pattern that branches or tags must match in order to deploy to the environment. * * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. * 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). */ name: string; + /** + * @description Whether this rule targets a branch or tag + * @enum {string} + */ + type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { @@ -30274,7 +30905,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-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"]); + "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-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"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -30311,6 +30942,11 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -31550,6 +32186,10 @@ export interface components { */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -34033,6 +34673,53 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; + /** custom property created event */ + "webhook-custom-property-created": { + /** @enum {string} */ + action: "created"; + definition: components["schemas"]["org-custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property deleted event */ + "webhook-custom-property-deleted": { + /** @enum {string} */ + action: "deleted"; + definition: { + /** @description The name of the property that was deleted. */ + property_name: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property updated event */ + "webhook-custom-property-updated": { + /** @enum {string} */ + action: "updated"; + definition: components["schemas"]["org-custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Custom property values updated event */ + "webhook-custom-property-values-updated": { + /** @enum {string} */ + 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-webhooks"]; + /** @description The new custom property values for the repository. */ + new_property_values: components["schemas"]["custom-property-value"][]; + /** @description The old custom property values for the repository. */ + old_property_values: components["schemas"]["custom-property-value"][]; + }; /** delete event */ "webhook-delete": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -37411,6 +38098,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -44352,6 +45043,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -46318,6 +47013,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -83071,6 +83770,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -86823,6 +87526,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -87132,6 +87839,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -87441,6 +88152,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -87781,6 +88496,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -88090,6 +88809,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -90814,6 +91537,8 @@ export interface components { "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 The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -90870,6 +91595,10 @@ export interface components { "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; /** @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`. @@ -90895,6 +91624,8 @@ export interface components { "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; + /** @description The custom property name. The name is case sensitive. */ + "custom-property-name": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; /** @description The time period to filter by. @@ -90914,8 +91645,6 @@ export interface components { "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 The slug of the team name. */ - "team-slug": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -92036,6 +92765,8 @@ 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. */ 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"]; }; header?: never; path: { @@ -95576,7 +96307,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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; @@ -95619,7 +96350,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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; @@ -95662,7 +96393,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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; @@ -95705,7 +96436,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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; @@ -96986,7 +97717,7 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - "copilot/get-copilot-seat-assignment-details-for-user": { + "copilot/get-copilot-seat-details-for-user": { parameters: { query?: never; header?: never; @@ -97012,7 +97743,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business is not enabled for this organization or the user has a pending organization invitation. */ + /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */ 422: { headers: { [name: string]: unknown; @@ -97352,6 +98083,451 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "orgs/list-organization-fine-grained-permissions": { + 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-fine-grained-permission"][]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/list-org-roles": { + 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 - list of organization roles */ + 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"][]; + }; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/create-custom-organization-role": { + 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 custom role. */ + name: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "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?: 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 Response */ + 204: { + headers: { + [name: string]: unknown; + }; + 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; + }; + }; + }; + "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 */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "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 handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "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 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: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @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; + }; + }; + }; + "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 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: { + 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 */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/delete-custom-organization-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: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "orgs/patch-custom-organization-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: { + content: { + "application/json": { + /** @description The name of the custom role. */ + name?: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/list-org-role-teams": { + parameters: { + query?: { + /** @description The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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"][]; + }; + }; + /** @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 The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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 users */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + /** @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-outside-collaborators": { parameters: { query?: { @@ -98077,6 +99253,219 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; + "orgs/get-all-custom-properties": { + 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"]["org-custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-or-update-custom-properties": { + 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. */ + properties: components["schemas"]["org-custom-property"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/get-custom-property": { + 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. The name is case sensitive. */ + 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"]["org-custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-or-update-custom-property": { + 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. The name is case sensitive. */ + custom_property_name: components["parameters"]["custom-property-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of the value for the property + * @enum {string} + */ + value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | null; + /** @description Short description of the property */ + description?: string | null; + /** @description Ordered list of allowed values of the property */ + allowed_values?: string[] | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/remove-custom-property": { + 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. The name is case sensitive. */ + 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"]; + }; + }; + "orgs/list-custom-properties-values-for-repos": { + parameters: { + query?: { + /** @description The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-or-update-custom-properties-values-for-repos": { + 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 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 No Content when custom property values are successfully created or updated */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "orgs/list-public-members": { parameters: { query?: { @@ -98348,6 +99737,10 @@ export interface operations { * @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; + }; }; }; }; @@ -98632,6 +100025,8 @@ export interface operations { 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"]; }; header?: never; path: { @@ -105781,7 +107176,7 @@ export interface operations { content: { "application/json": { commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - ref: components["schemas"]["code-scanning-ref"]; + ref: components["schemas"]["code-scanning-ref-full"]; sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** * Format: uri @@ -111514,6 +112909,7 @@ export interface operations { "application/json": components["schemas"]["license-content"]; }; }; + 404: components["responses"]["not_found"]; }; }; "repos/merge-upstream": { @@ -112391,6 +113787,33 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; + "repos/get-custom-properties-values": { + 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"]["custom-property-value"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "pulls/list": { parameters: { query?: { @@ -114612,6 +116035,8 @@ export interface operations { 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"]; }; header?: never; path: { @@ -121295,14 +122720,200 @@ export interface operations { }; }; }; - "billing/get-github-actions-billing-user": { + "billing/get-github-actions-billing-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @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"]["actions-billing-usage"]; + }; + }; + }; + }; + "billing/get-github-packages-billing-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @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"]["packages-billing-usage"]; + }; + }; + }; + }; + "billing/get-shared-storage-billing-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @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"]["combined-billing-usage"]; + }; + }; + }; + }; + "users/list-social-accounts-for-user": { + parameters: { + query?: { + /** @description The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + page?: components["parameters"]["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"]["social-account"][]; + }; + }; + }; + }; + "users/list-ssh-signing-keys-for-user": { + parameters: { + query?: { + /** @description The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + page?: components["parameters"]["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"]["ssh-signing-key"][]; + }; + }; + }; + }; + "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. */ + 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). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + page?: components["parameters"]["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"]["starred-repository"][] | components["schemas"]["repository"][]; + }; + }; + }; + }; + "activity/list-repos-watched-by-user": { + parameters: { + query?: { + /** @description The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + page?: components["parameters"]["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"]["minimal-repository"][]; + }; + }; + }; + }; + "meta/get-all-versions": { parameters: { query?: never; header?: never; - path: { - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; + path?: never; cookie?: never; }; requestBody?: never; @@ -121313,19 +122924,17 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": string[]; }; }; + 404: components["responses"]["not_found"]; }; }; - "billing/get-github-packages-billing-user": { + "meta/get-zen": { parameters: { query?: never; header?: never; - path: { - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; + path?: never; cookie?: never; }; requestBody?: never; @@ -121336,196 +122945,160 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": string; }; }; }; }; - "billing/get-shared-storage-billing-user": { + "branch-protection-configuration/disabled": { parameters: { query?: never; - header?: never; - path: { - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + 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?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["combined-billing-usage"]; - }; - }; - }; - }; - "users/list-social-accounts-for-user": { - parameters: { - query?: { - /** @description The number of results per page (max 100). */ - per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-branch-protection-configuration-disabled"]; }; - cookie?: never; }; - requestBody?: never; responses: { - /** @description Response */ + /** @description Return a 200 status to indicate that the data was received successfully */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["social-account"][]; - }; + content?: never; }; }; }; - "users/list-ssh-signing-keys-for-user": { + "branch-protection-configuration/enabled": { parameters: { - query?: { - /** @description The number of results per page (max 100). */ - per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + 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?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["ssh-signing-key"][]; - }; - }; - }; - }; - "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. */ - 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). */ - per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-branch-protection-configuration-enabled"]; }; - cookie?: never; }; - requestBody?: never; responses: { - /** @description Response */ + /** @description Return a 200 status to indicate that the data was received successfully */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["starred-repository"][] | components["schemas"]["repository"][]; - }; + content?: never; }; }; }; - "activity/list-repos-watched-by-user": { + "branch-protection-rule/created": { parameters: { - query?: { - /** @description The number of results per page (max 100). */ - per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + 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?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["minimal-repository"][]; - }; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-branch-protection-rule-created"]; }; }; - }; - "meta/get-all-versions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; responses: { - /** @description Response */ + /** @description Return a 200 status to indicate that the data was received successfully */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": string[]; - }; + content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "meta/get-zen": { + "branch-protection-rule/deleted": { parameters: { query?: never; - header?: 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?: never; + requestBody: { + content: { + "application/json": components["schemas"]["webhook-branch-protection-rule-deleted"]; + }; + }; responses: { - /** @description Response */ + /** @description Return a 200 status to indicate that the data was received successfully */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": string; - }; + content?: never; }; }; }; - "branch-protection-configuration/disabled": { + "branch-protection-rule/edited": { parameters: { query?: never; header?: { @@ -121549,7 +123122,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-branch-protection-configuration-disabled"]; + "application/json": components["schemas"]["webhook-branch-protection-rule-edited"]; }; }; responses: { @@ -121562,7 +123135,7 @@ export interface operations { }; }; }; - "branch-protection-configuration/enabled": { + "check-run/completed": { parameters: { query?: never; header?: { @@ -121586,7 +123159,8 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-branch-protection-configuration-enabled"]; + "application/json": components["schemas"]["webhook-check-run-completed"]; + "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-completed-form-encoded"]; }; }; responses: { @@ -121599,7 +123173,7 @@ export interface operations { }; }; }; - "branch-protection-rule/created": { + "check-run/created": { parameters: { query?: never; header?: { @@ -121623,7 +123197,8 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-branch-protection-rule-created"]; + "application/json": components["schemas"]["webhook-check-run-created"]; + "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-created-form-encoded"]; }; }; responses: { @@ -121636,7 +123211,7 @@ export interface operations { }; }; }; - "branch-protection-rule/deleted": { + "check-run/requested-action": { parameters: { query?: never; header?: { @@ -121660,7 +123235,8 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-branch-protection-rule-deleted"]; + "application/json": components["schemas"]["webhook-check-run-requested-action"]; + "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-requested-action-form-encoded"]; }; }; responses: { @@ -121673,7 +123249,7 @@ export interface operations { }; }; }; - "branch-protection-rule/edited": { + "check-run/rerequested": { parameters: { query?: never; header?: { @@ -121697,7 +123273,8 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-branch-protection-rule-edited"]; + "application/json": components["schemas"]["webhook-check-run-rerequested"]; + "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-rerequested-form-encoded"]; }; }; responses: { @@ -121710,7 +123287,7 @@ export interface operations { }; }; }; - "check-run/completed": { + "check-suite/completed": { parameters: { query?: never; header?: { @@ -121734,8 +123311,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-run-completed"]; - "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-completed-form-encoded"]; + "application/json": components["schemas"]["webhook-check-suite-completed"]; }; }; responses: { @@ -121748,7 +123324,7 @@ export interface operations { }; }; }; - "check-run/created": { + "check-suite/requested": { parameters: { query?: never; header?: { @@ -121772,8 +123348,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-run-created"]; - "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-created-form-encoded"]; + "application/json": components["schemas"]["webhook-check-suite-requested"]; }; }; responses: { @@ -121786,7 +123361,7 @@ export interface operations { }; }; }; - "check-run/requested-action": { + "check-suite/rerequested": { parameters: { query?: never; header?: { @@ -121810,8 +123385,7 @@ 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-suite-rerequested"]; }; }; responses: { @@ -121824,7 +123398,7 @@ export interface operations { }; }; }; - "check-run/rerequested": { + "code-scanning-alert/appeared-in-branch": { parameters: { query?: never; header?: { @@ -121848,8 +123422,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-appeared-in-branch"]; }; }; responses: { @@ -121862,7 +123435,7 @@ export interface operations { }; }; }; - "check-suite/completed": { + "code-scanning-alert/closed-by-user": { parameters: { query?: never; header?: { @@ -121886,7 +123459,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-suite-completed"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-closed-by-user"]; }; }; responses: { @@ -121899,7 +123472,7 @@ export interface operations { }; }; }; - "check-suite/requested": { + "code-scanning-alert/created": { parameters: { query?: never; header?: { @@ -121923,7 +123496,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-suite-requested"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-created"]; }; }; responses: { @@ -121936,7 +123509,7 @@ export interface operations { }; }; }; - "check-suite/rerequested": { + "code-scanning-alert/fixed": { parameters: { query?: never; header?: { @@ -121960,7 +123533,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-suite-rerequested"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-fixed"]; }; }; responses: { @@ -121973,7 +123546,7 @@ export interface operations { }; }; }; - "code-scanning-alert/appeared-in-branch": { + "code-scanning-alert/reopened": { parameters: { query?: never; header?: { @@ -121997,7 +123570,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-appeared-in-branch"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-reopened"]; }; }; responses: { @@ -122010,7 +123583,7 @@ export interface operations { }; }; }; - "code-scanning-alert/closed-by-user": { + "code-scanning-alert/reopened-by-user": { parameters: { query?: never; header?: { @@ -122034,7 +123607,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-closed-by-user"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-reopened-by-user"]; }; }; responses: { @@ -122047,7 +123620,7 @@ export interface operations { }; }; }; - "code-scanning-alert/created": { + "commit-comment/created": { parameters: { query?: never; header?: { @@ -122071,7 +123644,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-created"]; + "application/json": components["schemas"]["webhook-commit-comment-created"]; }; }; responses: { @@ -122084,7 +123657,7 @@ export interface operations { }; }; }; - "code-scanning-alert/fixed": { + create: { parameters: { query?: never; header?: { @@ -122108,7 +123681,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-fixed"]; + "application/json": components["schemas"]["webhook-create"]; }; }; responses: { @@ -122121,7 +123694,7 @@ export interface operations { }; }; }; - "code-scanning-alert/reopened": { + "custom-property/created": { parameters: { query?: never; header?: { @@ -122145,7 +123718,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-reopened"]; + "application/json": components["schemas"]["webhook-custom-property-created"]; }; }; responses: { @@ -122158,7 +123731,7 @@ export interface operations { }; }; }; - "code-scanning-alert/reopened-by-user": { + "custom-property/deleted": { parameters: { query?: never; header?: { @@ -122182,7 +123755,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-reopened-by-user"]; + "application/json": components["schemas"]["webhook-custom-property-deleted"]; }; }; responses: { @@ -122195,7 +123768,7 @@ export interface operations { }; }; }; - "commit-comment/created": { + "custom-property/updated": { parameters: { query?: never; header?: { @@ -122219,7 +123792,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-commit-comment-created"]; + "application/json": components["schemas"]["webhook-custom-property-updated"]; }; }; responses: { @@ -122232,7 +123805,7 @@ export interface operations { }; }; }; - create: { + "custom-property-values/updated": { parameters: { query?: never; header?: { @@ -122256,7 +123829,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-create"]; + "application/json": components["schemas"]["webhook-custom-property-values-updated"]; }; }; responses: { diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index 33d868f79..97b7cdfc0 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -85,6 +85,8 @@ tags: description: Owner or admin management of users interactions. - name: classroom description: Interact with GitHub Classroom. +- name: desktop + description: Desktop specific endpoints. servers: - url: https://api.github.com externalDocs: @@ -1506,6 +1508,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" responses: '200': description: Response @@ -1743,7 +1746,7 @@ paths: description: |- List public gists sorted by most recently updated to least recently updated. - Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + 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. tags: - gists operationId: gists/list-public @@ -5763,8 +5766,6 @@ paths: To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. For public repositories, you may instead use the `public_repo` scope. - - GitHub Apps must have the `security_events` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/list-alerts-for-org @@ -5834,7 +5835,7 @@ paths: description: |- Lists the codespaces associated to a specified organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. tags: - codespaces operationId: codespaces/list-in-organization @@ -5885,7 +5886,7 @@ paths: summary: Manage access control for organization codespaces 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. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access @@ -5956,7 +5957,7 @@ paths: To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access-users @@ -6014,7 +6015,7 @@ paths: To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. tags: - codespaces operationId: codespaces/delete-codespaces-access-users @@ -6068,7 +6069,7 @@ paths: get: summary: List organization secrets description: |- - Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. + Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: - codespaces @@ -6142,7 +6143,7 @@ paths: get: summary: Get an organization secret description: |- - Gets an organization secret without revealing its encrypted value. + Gets an organization development environment secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: - codespaces @@ -6174,7 +6175,7 @@ paths: put: summary: Create or update an organization secret description: |- - Creates or updates an organization secret with an encrypted value. Encrypt your secret using + Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." You must authenticate using an access @@ -6260,9 +6261,9 @@ paths: subcategory: organization-secrets delete: summary: Delete an organization secret - description: Deletes an organization secret using the secret name. You must - authenticate using an access token with the `admin:org` scope to use this - endpoint. + description: Deletes an organization development environment secret using the + secret name. You must authenticate using an access token with the `admin:org` + scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-org-secret @@ -6328,9 +6329,9 @@ paths: subcategory: organization-secrets put: summary: Set selected repositories for an organization secret - description: Replaces all repositories for an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + description: Replaces all repositories for an organization development environment + secret when the `visibility` for repository access is set to `selected`. The + visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: @@ -6382,9 +6383,9 @@ paths: "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret - description: Adds a repository to an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-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). You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: @@ -6417,9 +6418,9 @@ paths: subcategory: organization-secrets delete: summary: Remove selected repository from an organization secret - description: Removes a repository from an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + description: Removes a repository from an organization development environment + secret when the `visibility` for repository access is set to `selected`. The + visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: @@ -6452,22 +6453,22 @@ paths: subcategory: organization-secrets "/orgs/{org}/copilot/billing": get: - summary: Get Copilot for Business seat information and settings for an organization + summary: Get Copilot Business seat information and settings for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Gets information about an organization's Copilot for Business subscription, including seat breakdown + Gets information about an organization's Copilot Business subscription, including seat breakdown and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-information-and-settings-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#get-copilot-business-seat-information-and-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: @@ -6492,23 +6493,23 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/copilot/billing/seats": get: - summary: List all Copilot for Business seat assignments for an organization + summary: List all Copilot Business seat assignments for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). - Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#list-all-copilot-for-business-seat-assignments-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#list-all-copilot-business-seat-assignments-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/page" @@ -6552,28 +6553,28 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/copilot/billing/selected_teams": post: - summary: Add teams to the Copilot for Business subscription for an organization + summary: Add teams to the Copilot Business subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Purchases a GitHub Copilot for Business seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + Purchases a GitHub Copilot Business seat for all users within each specified team. + The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. - In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". tags: - copilot operationId: copilot/add-copilot-for-business-seats-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#add-teams-to-the-copilot-for-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#add-teams-to-the-copilot-business-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6625,26 +6626,26 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business 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 + description: Copilot Business 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. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business delete: - summary: Remove teams from the Copilot for Business subscription for an organization + summary: Remove teams from the Copilot Business subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Cancels the Copilot for Business seat assignment for all members of each team specified. + Cancels the Copilot Business seat assignment for all members of each team specified. This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". - For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -6653,7 +6654,7 @@ paths: operationId: copilot/cancel-copilot-seat-assignment-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#remove-teams-from-the-copilot-for-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#remove-teams-from-the-copilot-business-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6705,36 +6706,36 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business 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 + description: Copilot Business 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. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/copilot/billing/selected_users": post: - summary: Add users to the Copilot for Business subscription for an organization + summary: Add users to the Copilot Business subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Purchases a GitHub Copilot for Business seat for each user specified. - The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + Purchases a GitHub Copilot Business seat for each user specified. + The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. - In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". tags: - copilot operationId: copilot/add-copilot-for-business-seats-for-users externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#add-users-to-the-copilot-for-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#add-users-to-the-copilot-business-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6786,26 +6787,26 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business 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 + description: Copilot Business 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. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business delete: - summary: Remove users from the Copilot for Business subscription for an organization + summary: Remove users from the Copilot Business subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Cancels the Copilot for Business seat assignment for each user specified. + Cancels the Copilot Business seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" - For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -6814,7 +6815,7 @@ paths: operationId: copilot/cancel-copilot-seat-assignment-for-users externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#remove-users-from-the-copilot-for-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#remove-users-from-the-copilot-business-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6866,16 +6867,16 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business 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. + description: Copilot Business 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. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/dependabot/alerts": get: summary: List Dependabot alerts for an organization @@ -8122,7 +8123,8 @@ paths: description: |- Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - orgs operationId: orgs/create-invitation @@ -8470,7 +8472,7 @@ paths: description: |- Lists the codespaces that a member of an organization has for repositories in that organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. tags: - codespaces operationId: codespaces/get-codespaces-for-user-in-org @@ -8523,7 +8525,10 @@ paths: description: |- Deletes a user's codespace. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + To use this endpoint you must authenticate using one of the following methods: + + - An access token with the `admin:org` scope + - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` tags: - codespaces operationId: codespaces/delete-from-organization @@ -8558,7 +8563,10 @@ paths: description: |- Stops a user's codespace. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + To use this endpoint you must authenticate using one of the following methods: + + - An access token with the `admin:org` scope + - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` tags: - codespaces operationId: codespaces/stop-in-organization @@ -8596,19 +8604,19 @@ paths: subcategory: organizations "/orgs/{org}/members/{username}/copilot": get: - summary: Get Copilot for Business seat assignment details for a user + summary: Get Copilot Business seat assignment details for a user description: |- **Note**: This endpoint is in beta and is subject to change. - Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. tags: - copilot - operationId: copilot/get-copilot-seat-assignment-details-for-user + operationId: copilot/get-copilot-seat-details-for-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user + url: https://docs.github.com/rest/copilot/copilot-business#get-copilot-business-seat-assignment-details-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" @@ -8631,13 +8639,13 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business is not enabled for this organization or - the user has a pending organization invitation. + description: Copilot Business is not enabled for this organization or the + user has a pending organization invitation. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/memberships/{username}": get: summary: Get organization membership for a user @@ -9081,6 +9089,633 @@ paths: enabledForGitHubApps: false category: migrations subcategory: orgs + "/orgs/{org}/organization-fine-grained-permissions": + get: + summary: List organization fine-grained permissions for an organization + description: |- + **Note**: This operation is in beta and subject to change. + + Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + tags: + - orgs + operationId: orgs/list-organization-fine-grained-permissions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-fine-grained-permission" + examples: + default: + "$ref": "#/components/examples/organization-fine-grained-permission-example" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles": + get: + summary: Get all organization roles for an organization + description: |- + Lists the organization roles available in this organization. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/list-org-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response - list of organization roles + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + description: The total number of organization roles available + to the organization. + roles: + type: array + description: The list of organization roles available to the organization. + items: + "$ref": "#/components/schemas/organization-role" + examples: + default: + "$ref": "#/components/examples/organization-role-list" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + post: + summary: Create a custom organization role + description: |- + Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + + For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/create-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the custom role. + description: + type: string + description: A short description about the intended usage of this + role or what permissions it grants. + permissions: + type: array + description: A list of additional permissions included in this role. + items: + type: string + required: + - name + - permissions + examples: + default: + value: + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + examples: + default: + value: + id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + 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 + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:19:11Z' + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/teams/{team_slug}": + delete: + summary: Remove all organization roles for a team + description: |- + Removes all assigned organization roles from a team. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members:write` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/revoke-all-org-roles-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": + put: + summary: Assign an organization role to a team + description: |- + Assigns an organization role to a team in an organization. + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members` organization read-write permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/assign-team-to-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + '404': + description: Response if the organization, team or role does not exist. + '422': + description: Response if the organization roles feature is not enabled for + the organization, or validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + delete: + summary: Remove an organization role from a team + description: |- + Removes an organization role from a team. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members:write` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/revoke-org-role-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/users/{username}": + delete: + summary: Remove all organization roles for a user + description: |- + Revokes all assigned organization roles from a user. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members:write` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/revoke-all-org-roles-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/users/{username}/{role_id}": + put: + summary: Assign an organization role to a user + description: |- + Assigns an organization role to a member of an organization. + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members` organization read-write permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/assign-user-to-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + '404': + description: Response if the organization, user or role does not exist. + '422': + 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. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + delete: + summary: Remove an organization role from a user + description: |- + Remove an organization role from a user. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members:write` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/revoke-org-role-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/{role_id}": + get: + summary: Get an organization role + description: |- + Gets an organization role that is available to this organization. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/get-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + examples: + default: + "$ref": "#/components/examples/organization-role" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + patch: + summary: Update a custom organization role + description: |- + Updates an existing custom organization role. Permission changes will apply to all assignees. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + + For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/patch-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the custom role. + description: + type: string + description: A short description about the intended usage of this + role or what permissions it grants. + permissions: + type: array + description: A list of additional permissions included in this role. + items: + type: string + examples: + default: + value: + description: Permissions to manage custom roles within an org. + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + examples: + default: + value: + id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + 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 + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:19:11Z' + '422': + "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + delete: + summary: Delete a custom organization role. + description: |- + Deletes a custom organization role. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + + For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/delete-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/{role_id}/teams": + get: + summary: List teams that are assigned to an organization role + description: |- + Lists the teams that are assigned to an organization role. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members` organization read permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/list-org-role-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response - List of assigned teams + content: + application/json: + schema: + type: array + description: List of teams assigned to the organization role + items: + "$ref": "#/components/schemas/team" + examples: + default: + "$ref": "#/components/examples/team-items" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + description: Response if the organization or role does not exist. + '422': + description: Response if the organization roles feature is not enabled or + validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/{role_id}/users": + get: + summary: List users that are assigned to an organization role + description: |- + Lists organization members that are assigned to an organization role. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members` organization read permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/list-org-role-users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response - List of assigned users + content: + application/json: + schema: + type: array + description: List of users assigned to the organization role + items: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user-items" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + description: Response if the organization or role does not exist. + '422': + description: Response if the organization roles feature is not enabled or + validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles "/orgs/{org}/outside_collaborators": get: summary: List outside collaborators for an organization @@ -10139,6 +10774,359 @@ paths: enabledForGitHubApps: true category: projects subcategory: projects + "/orgs/{org}/properties/schema": + get: + summary: Get all custom properties for an organization + description: |- + Gets all custom properties defined for an organization. + You must be an organization owner to use this endpoint. + tags: + - orgs + operationId: orgs/get-all-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-custom-property" + examples: + default: + "$ref": "#/components/examples/org-custom-properties" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + patch: + summary: Create or update custom properties for an organization + description: |- + Creates new or updates existing custom properties defined for an organization in a batch. + Only organization owners (or users with the proper permissions granted by them) can update these properties + tags: + - orgs + operationId: orgs/create-or-update-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of custom properties to create or update. + items: + "$ref": "#/components/schemas/org-custom-property" + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + - property_name: service + value_type: string + - property_name: team + value_type: string + description: Team owning the repository + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-custom-property" + examples: + default: + "$ref": "#/components/examples/org-custom-properties" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + "/orgs/{org}/properties/schema/{custom_property_name}": + get: + summary: Get a custom property for an organization + description: |- + Gets a custom property that is defined for an organization. + You must be an organization owner to use this endpoint. + tags: + - orgs + operationId: orgs/get-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/custom-property-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-custom-property" + examples: + default: + "$ref": "#/components/examples/org-custom-property" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + put: + summary: 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. + You must be an organization owner to use this endpoint. + tags: + - orgs + operationId: orgs/create-or-update-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/custom-property-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + value_type: + type: string + enum: + - string + - single_select + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + type: + - string + - 'null' + description: Default value of the property + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + description: Ordered list of allowed values of the property + required: + - value_type + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-custom-property" + examples: + default: + "$ref": "#/components/examples/org-custom-property" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + delete: + summary: Remove a custom property for an organization + description: |- + Removes a custom property that is defined for an organization. + You must be an organization owner to use this endpoint. + tags: + - orgs + operationId: orgs/remove-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/custom-property-name" + responses: + '204': + "$ref": "#/components/responses/no_content" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + "/orgs/{org}/properties/values": + get: + summary: List custom property values for organization repositories + description: |- + Lists organization repositories with all of their custom property values. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/list-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: repository_query + 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. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-repo-custom-property-values" + examples: + default: + "$ref": "#/components/examples/org-repo-custom-property-values" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + patch: + summary: 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. + Each target repository will have its custom property values updated to match the values provided in the request. + + A maximum of 30 repositories can be updated in a single request. + + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Only organization owners (or users with the proper permissions granted by them) can update these properties + tags: + - orgs + operationId: orgs/create-or-update-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_names: + type: array + description: The names of repositories that the custom property + values will be applied to. + items: + type: string + minItems: 1 + maxItems: 30 + properties: + type: array + description: List of custom property names and associated values + to apply to the repositories. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - repository_names + - properties + examples: + default: + "$ref": "#/components/examples/org-repo-update-custom-property-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties "/orgs/{org}/public_members": get: summary: List public organization members @@ -10489,6 +11477,12 @@ paths: - `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. + custom_properties: + type: object + description: The custom properties for the new repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true required: - name examples: @@ -10914,6 +11908,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" responses: '200': description: Response @@ -11542,7 +12537,7 @@ paths: description: |- Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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`. tags: @@ -11747,7 +12742,7 @@ paths: description: |- Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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`. tags: @@ -12627,6 +13622,8 @@ paths: If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: - teams @@ -12811,8 +13808,7 @@ paths: - extended examples: default: - value: - query_suite: default + value: responses: '204': description: Action started @@ -20431,9 +21427,6 @@ paths: To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - GitHub Apps must have the `security_events` read - permission to use this endpoint. - The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert for the default branch (or for the specified Git reference if you used `ref` in the request). @@ -20507,8 +21500,7 @@ paths: description: Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on - public repos only. GitHub Apps must have the `security_events` read permission - to use this endpoint. + public repos only. tags: - code-scanning operationId: code-scanning/get-alert @@ -20547,8 +21539,7 @@ paths: description: Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope - for public repositories only. GitHub Apps must have the `security_events` - write permission to use this endpoint. + for public repositories only. operationId: code-scanning/update-alert tags: - code-scanning @@ -20609,7 +21600,6 @@ paths: Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. - GitHub Apps must have the `security_events` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/list-alert-instances @@ -20663,7 +21653,6 @@ paths: You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. - GitHub Apps must have the `security_events` read permission to use this endpoint. **Deprecation notice**: The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. @@ -20734,7 +21723,6 @@ paths: Gets a specified code scanning analysis for a repository. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. - GitHub Apps must have the `security_events` read permission to use this endpoint. The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, @@ -20921,7 +21909,6 @@ paths: For private repositories, you must use an access token with the `security_events` scope. For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - GitHub Apps must have the `contents` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/list-codeql-databases @@ -20969,7 +21956,6 @@ paths: For private repositories, you must use an access token with the `security_events` scope. For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - GitHub Apps must have the `contents` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/get-codeql-database @@ -21015,7 +22001,7 @@ paths: description: |- Gets a code scanning default setup configuration. You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + scope for public repos. tags: - code-scanning operationId: code-scanning/get-default-setup @@ -21051,7 +22037,7 @@ paths: description: |- Updates a code scanning default setup configuration. You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + scope for public repos. tags: - code-scanning operationId: code-scanning/update-default-setup @@ -21164,7 +22150,7 @@ paths: commit_sha: "$ref": "#/components/schemas/code-scanning-analysis-commit-sha" ref: - "$ref": "#/components/schemas/code-scanning-ref" + "$ref": "#/components/schemas/code-scanning-ref-full" sarif: "$ref": "#/components/schemas/code-scanning-analysis-sarif-file" checkout_uri: @@ -21193,6 +22179,7 @@ paths: 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. type: boolean + additionalProperties: false required: - commit_sha - ref @@ -21237,8 +22224,7 @@ paths: for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission - to read security events on public repos only. GitHub Apps must have the `security_events` - read permission to use this endpoint. + to read security events on public repos only. operationId: code-scanning/get-sarif tags: - code-scanning @@ -21761,10 +22747,10 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets": get: summary: List repository secrets - description: Lists all secrets available in a repository without revealing their - encrypted values. You must authenticate using an access token with the `repo` - scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - repository permission to use this endpoint. + description: Lists all development environment secrets available in a repository + without revealing their encrypted values. You must authenticate using an access + token with the `repo` scope to use this endpoint. GitHub Apps must have write + access to the `codespaces_secrets` repository permission to use this endpoint. tags: - codespaces operationId: codespaces/list-repo-secrets @@ -21840,10 +22826,10 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": get: summary: Get a repository secret - description: Gets a single repository secret without revealing its encrypted - value. You must authenticate using an access token with the `repo` scope to - use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - repository permission to use this endpoint. + description: Gets a single repository development environment secret without + revealing its encrypted value. You must authenticate using an access token + with the `repo` scope to use this endpoint. GitHub Apps must have write access + to the `codespaces_secrets` repository permission to use this endpoint. tags: - codespaces operationId: codespaces/get-repo-secret @@ -21872,7 +22858,7 @@ paths: put: summary: Create or update a repository secret description: |- - Creates or updates a repository secret with an encrypted value. Encrypt your secret using + 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)." You must authenticate using an access @@ -21929,10 +22915,10 @@ paths: subcategory: repository-secrets delete: summary: Delete a repository secret - description: Deletes a secret in a repository using the secret name. You must - authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have write access to the `codespaces_secrets` repository - permission to use this endpoint. + description: Deletes a development environment secret in a repository using + the secret name. You must authenticate using an access token with the `repo` + scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` + repository permission to use this endpoint. tags: - codespaces operationId: codespaces/delete-repo-secret @@ -22058,7 +23044,7 @@ 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." @@ -22687,7 +23673,7 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - repos operationId: repos/create-commit-comment @@ -24899,7 +25885,7 @@ paths: post: summary: Create a deployment branch policy description: |- - Creates a deployment branch policy for an environment. + Creates a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. tags: @@ -24927,6 +25913,12 @@ paths: summary: Example of a single branch name pattern value: name: main + type: branch + example-single-tag: + summary: Example of a single tag name pattern + value: + name: v1 + type: tag responses: '200': description: Response @@ -24939,6 +25931,8 @@ paths: "$ref": "#/components/examples/deployment-branch-policy-wildcard" example-single-branch: "$ref": "#/components/examples/deployment-branch-policy-single-branch" + example-single-tag: + "$ref": "#/components/examples/deployment-branch-policy-single-tag" '404': description: Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false @@ -24953,7 +25947,7 @@ paths: get: summary: Get a deployment branch policy description: |- - Gets a deployment branch policy for an environment. + Gets a deployment branch or tag policy for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. tags: @@ -24985,7 +25979,7 @@ paths: put: summary: Update a deployment branch policy description: |- - Updates a deployment branch policy for an environment. + Updates a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. tags: @@ -25027,7 +26021,7 @@ paths: delete: summary: Delete a deployment branch policy description: |- - Deletes a deployment branch policy for an environment. + Deletes a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. tags: @@ -26342,7 +27336,7 @@ paths: operationId: repos/list-webhooks externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#list-repository-webhooks + url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26368,8 +27362,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks post: summary: Create a repository webhook description: |- @@ -26380,7 +27374,7 @@ paths: operationId: repos/create-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#create-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26467,8 +27461,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}": get: summary: Get a repository webhook @@ -26479,7 +27473,7 @@ paths: operationId: repos/get-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#get-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26499,8 +27493,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks patch: summary: Update a repository webhook description: Updates a webhook configured in a repository. If you previously @@ -26512,7 +27506,7 @@ paths: operationId: repos/update-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#update-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26594,8 +27588,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks delete: summary: Delete a repository webhook description: '' @@ -26604,7 +27598,7 @@ paths: operationId: repos/delete-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#delete-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26617,8 +27611,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for a repository @@ -26631,7 +27625,7 @@ paths: operationId: repos/get-webhook-config-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository + url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26649,8 +27643,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-config + category: repos + subcategory: webhooks patch: summary: Update a webhook configuration for a repository description: |- @@ -26662,7 +27656,7 @@ paths: operationId: repos/update-webhook-config-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository + url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26702,8 +27696,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-config + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": get: summary: List deliveries for a repository webhook @@ -26714,7 +27708,7 @@ paths: operationId: repos/list-webhook-deliveries externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26745,8 +27739,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-deliveries + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a delivery for a repository webhook @@ -26756,7 +27750,7 @@ paths: operationId: repos/get-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26779,8 +27773,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-deliveries + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for a repository webhook @@ -26790,7 +27784,7 @@ paths: operationId: repos/redeliver-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26806,8 +27800,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-deliveries + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/pings": post: summary: Ping a repository webhook @@ -26818,7 +27812,7 @@ paths: operationId: repos/ping-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#ping-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26831,8 +27825,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/tests": post: summary: Test the push repository webhook @@ -26845,7 +27839,7 @@ paths: operationId: repos/test-push-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#test-the-push-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26858,17 +27852,15 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/import": get: summary: Get an import status description: |- View the progress of an import. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). **Import status** @@ -26930,11 +27922,17 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true put: summary: Start an import - description: |- - Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + description: | + Start a source import to a GitHub repository using GitHub Importer. + Importing into a GitHub repository with GitHub Actions enabled is not supported and will + return a status `422 Unprocessable Entity` response. + + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/start-import @@ -27012,6 +28010,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true patch: summary: Update an import description: |- @@ -27022,9 +28023,7 @@ paths: have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/update-import @@ -27101,14 +28100,15 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true delete: summary: Cancel an import description: | Stop an import for a repository. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/cancel-import @@ -27128,6 +28128,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/import/authors": get: summary: Get commit authors @@ -27136,9 +28139,7 @@ paths: This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-commit-authors @@ -27170,6 +28171,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/import/authors/{author_id}": patch: summary: Map a commit author @@ -27177,9 +28181,7 @@ paths: Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/map-commit-author @@ -27234,15 +28236,16 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/import/large_files": get: summary: Get large files description: | List files larger than 100MB found during the import - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-large-files @@ -27271,6 +28274,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/import/lfs": patch: summary: Update Git LFS preference @@ -27281,9 +28287,7 @@ paths: You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/repositories/working-with-files/managing-large-files). - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/set-lfs-preference @@ -27333,6 +28337,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/installation": get: summary: Get a repository installation for the authenticated app @@ -27688,7 +28695,8 @@ paths: description: |- Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - issues operationId: issues/create @@ -28559,9 +29567,8 @@ 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. - See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" - and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" - for details. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/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)." tags: - issues operationId: issues/create-comment @@ -29651,6 +30658,8 @@ paths: examples: default: "$ref": "#/components/examples/license-content" + '404': + "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30832,6 +31841,42 @@ paths: enabledForGitHubApps: true category: projects subcategory: projects + "/repos/{owner}/{repo}/properties/values": + get: + summary: 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. + tags: + - repos + operationId: repos/get-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-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/custom-property-value" + examples: + default: + "$ref": "#/components/examples/custom-property-values" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests @@ -30932,7 +31977,7 @@ paths: To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/create @@ -31617,7 +32662,8 @@ paths: **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - This endpoint 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/create-review-comment @@ -31754,7 +32800,8 @@ paths: description: |- Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/create-reply-for-review-comment @@ -31917,7 +32964,7 @@ paths: summary: 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/merge @@ -32051,7 +33098,7 @@ paths: summary: 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/request-reviewers @@ -32211,7 +33258,7 @@ paths: post: summary: Create a review for a pull request 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." @@ -32805,7 +33852,7 @@ paths: 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - repos operationId: repos/create-release @@ -34002,6 +35049,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" responses: '200': description: Response @@ -34473,15 +35521,14 @@ paths: severity: critical state: published add_credit: - summary: When adding a credit to an advisory, you must send the whole - array of values. + summary: To add a credit to an advisory, send the whole array of values. value: credits: - login: monauser type: remediation_developer update_vvrs: - summary: When adding vulnerable versions, you must include existing - vulnerable versions in the array. + summary: To add vulnerable versions, include existing versions in + the array. value: - package: ecosystem: pip @@ -34498,8 +35545,8 @@ paths: vulnerable_functions: - function2 invalid_state_transition: - summary: Some state transitions are invalid, such as changing the - state from `published` to `draft` + summary: Example of an invalid state transition, from `published` + to `draft`. value: state: draft update_severity_with_cvss_set: @@ -36204,7 +37251,7 @@ paths: get: summary: Search code description: |- - Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36308,7 +37355,7 @@ paths: get: summary: Search commits description: |- - Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36381,7 +37428,7 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36476,7 +37523,7 @@ paths: get: summary: Search labels description: |- - Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36559,7 +37606,7 @@ paths: get: summary: Search repositories description: |- - Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36640,7 +37687,7 @@ paths: get: summary: Search topics description: |- - Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36701,7 +37748,7 @@ paths: get: summary: Search users description: |- - Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36999,7 +38046,7 @@ paths: Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - teams operationId: teams/create-discussion-legacy @@ -37214,7 +38261,7 @@ paths: Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - teams operationId: teams/create-discussion-comment-legacy @@ -38809,7 +39856,7 @@ paths: get: summary: List secrets for the authenticated user description: |- - Lists all secrets available for a user's Codespaces without revealing their + Lists all development environment secrets available for a user's codespaces without revealing their encrypted values. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -38886,7 +39933,7 @@ paths: get: summary: Get a secret for the authenticated user description: |- - Gets a secret available to a user's codespaces without revealing its encrypted value. + Gets a development environment secret available to a user's codespaces without revealing its encrypted value. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -38917,7 +39964,7 @@ paths: put: summary: Create or update a secret for the authenticated user description: |- - Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -38994,7 +40041,7 @@ paths: delete: summary: Delete a secret for the authenticated user description: |- - Deletes a 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. + 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. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -39019,7 +40066,7 @@ paths: get: summary: List selected repositories for a user secret description: |- - List the repositories that have been granted the ability to use a user's codespace secret. + List the repositories that have been granted the ability to use a user's development environment secret. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -39068,7 +40115,7 @@ paths: put: summary: Set selected repositories for a user secret description: |- - Select the repositories that will use a user's codespace secret. + Select the repositories that will use a user's development environment secret. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -39126,7 +40173,7 @@ paths: put: summary: Add a selected repository to a user secret description: |- - Adds a repository to the selected repositories for a user's codespace secret. + Adds a repository to the selected repositories for a user's development environment secret. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. tags: @@ -39161,7 +40208,7 @@ paths: delete: summary: Remove a selected repository from a user secret description: |- - Removes a repository from the selected repositories for a user's codespace secret. + Removes a repository from the selected repositories for a user's development environment secret. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. tags: @@ -44875,7 +45922,275 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-suite-requested" + "$ref": "#/components/schemas/webhook-check-suite-requested" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: check_suite + supported-webhook-types: + - repository + - organization + - app + check-suite-rerequested: + post: + summary: |- + This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/rest/checks/suites)" in the REST API documentation. + + For activity relating to check runs, use the `check_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. + + Repository and organization webhooks only receive payloads for the `completed` event types in repositories. + + **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + description: Someone requested to re-run the check runs in a check suite. For + more information, see [the GraphQL API documentation for creating a check + suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) + or "[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)" + in the REST API documentation. + operationId: check-suite/rerequested + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite + 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-check-suite-rerequested" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: check_suite + supported-webhook-types: + - repository + - organization + - app + code-scanning-alert-appeared-in-branch: + 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: A previously created code scanning alert appeared in another branch. + This can happen when a branch is merged into or created from a branch with + a pre-existing code scanning alert. + operationId: code-scanning-alert/appeared-in-branch + 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-appeared-in-branch" + 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 + code-scanning-alert-closed-by-user: + 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: Someone closed a code scanning alert. + operationId: code-scanning-alert/closed-by-user + 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-closed-by-user" + 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 + code-scanning-alert-created: + 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: A code scanning alert was created in a repository. + operationId: code-scanning-alert/created + 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-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -44883,31 +46198,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: check_suite + subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app - check-suite-rerequested: + code-scanning-alert-fixed: post: summary: |- - This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/rest/checks/suites)" in the REST API documentation. - - For activity relating to check runs, use the `check_run` event. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event. - - Repository and organization webhooks only receive payloads for the `completed` event types in repositories. + 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. - **Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - description: Someone requested to re-run the check runs in a check suite. For - more information, see [the GraphQL API documentation for creating a check - suite](https://docs.github.com/graphql/reference/mutations#createchecksuite) - or "[Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite)" - in the REST API documentation. - operationId: check-suite/rerequested + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: A code scanning alert was fixed in a branch by a commit. + operationId: code-scanning-alert/fixed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite + url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: - name: User-Agent in: header @@ -44949,7 +46254,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-check-suite-rerequested" + "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -44957,21 +46262,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: check_suite + subcategory: code_scanning_alert supported-webhook-types: - repository - organization - app - code-scanning-alert-appeared-in-branch: + code-scanning-alert-reopened: 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: A previously created code scanning alert appeared in another branch. - This can happen when a branch is merged into or created from a branch with - a pre-existing code scanning alert. - operationId: code-scanning-alert/appeared-in-branch + description: A previously fixed code scanning alert reappeared in a branch. + operationId: code-scanning-alert/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -45015,7 +46318,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-appeared-in-branch" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45028,14 +46331,14 @@ webhooks: - repository - organization - app - code-scanning-alert-closed-by-user: + code-scanning-alert-reopened-by-user: 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: Someone closed a code scanning alert. - operationId: code-scanning-alert/closed-by-user + description: Someone reopened a code scanning alert. + operationId: code-scanning-alert/reopened-by-user externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert parameters: @@ -45079,7 +46382,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-closed-by-user" + "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45092,16 +46395,18 @@ webhooks: - repository - organization - app - code-scanning-alert-created: + commit-comment-created: 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. + This event occurs when there is activity relating to commit comments. For more information about commit comments, 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)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/rest/commits/comments)" 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: A code scanning alert was created in a repository. - operationId: code-scanning-alert/created + For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: Someone commented on a commit. + operationId: commit-comment/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#commit_comment parameters: - name: User-Agent in: header @@ -45143,7 +46448,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-created" + "$ref": "#/components/schemas/webhook-commit-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45151,21 +46456,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: code_scanning_alert + subcategory: commit_comment supported-webhook-types: - repository - organization - app - code-scanning-alert-fixed: + create: 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. + This event occurs when a Git branch or tag is created. - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A code scanning alert was fixed in a branch by a commit. - operationId: code-scanning-alert/fixed + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + **Notes**: + - This event will not occur when more than three tags are created at once. + - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. + operationId: create externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#create parameters: - name: User-Agent in: header @@ -45207,7 +46515,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-fixed" + "$ref": "#/components/schemas/webhook-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45215,21 +46523,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: code_scanning_alert + subcategory: create supported-webhook-types: - repository - organization - app - code-scanning-alert-reopened: + custom-property-created: 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. + This event occurs when there is activity relating to a custom property. - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: A previously fixed code scanning alert reappeared in a branch. - operationId: code-scanning-alert/reopened + 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 new custom property was created. + operationId: custom-property/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -45271,7 +46581,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-custom-property-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45279,21 +46589,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: code_scanning_alert + subcategory: custom_property supported-webhook-types: - - repository - organization - app - code-scanning-alert-reopened-by-user: + custom-property-deleted: 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. + This event occurs when there is activity relating to a custom property. - To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. - description: Someone reopened a code scanning alert. - operationId: code-scanning-alert/reopened-by-user + 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 deleted. + operationId: custom-property/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -45335,7 +46646,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-code-scanning-alert-reopened-by-user" + "$ref": "#/components/schemas/webhook-custom-property-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45343,23 +46654,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: code_scanning_alert + subcategory: custom_property supported-webhook-types: - - repository - organization - app - commit-comment-created: + custom-property-updated: post: summary: |- - This event occurs when there is activity relating to commit comments. For more information about commit comments, 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)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/rest/commits/comments)" in the REST API documentation. + This event occurs when there is activity relating to a custom property. - For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event. + 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 "Contents" repository permission. - description: Someone commented on a commit. - operationId: commit-comment/created + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#commit_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -45401,7 +46711,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-commit-comment-created" + "$ref": "#/components/schemas/webhook-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45409,24 +46719,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: commit_comment + subcategory: custom_property supported-webhook-types: - - repository - organization - app - create: + custom-property-values-updated: post: summary: |- - This event occurs when a Git branch or tag is created. + 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. - **Notes**: - - This event will not occur when more than three tags are created at once. - - Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery. - operationId: create + 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#create + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values parameters: - name: User-Agent in: header @@ -45468,7 +46776,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-create" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45476,7 +46784,7 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: create + subcategory: custom-property-values supported-webhook-types: - repository - organization @@ -54355,7 +55663,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: The title or body of a pull request was edited. + 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 @@ -57173,7 +58482,7 @@ webhooks: 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 "Administration" repository permission. + 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: @@ -57239,7 +58548,7 @@ webhooks: 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 "Administration" repository permission. + 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: @@ -57305,7 +58614,7 @@ webhooks: 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 "Administration" repository permission. + 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: @@ -61175,6 +62484,14 @@ components: enum: - read - write + organization_custom_properties: + type: string + description: The level of permission to grant the access token for custom + property management. + enum: + - read + - write + - admin organization_announcement_banners: type: string description: The level of permission to grant the access token to view and @@ -62988,10 +64305,7 @@ components: ## Attribution - This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - - [homepage]: http://contributor-covenant.org - [version]: http://contributor-covenant.org/version/1/4/ + 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/). html_url: type: - string @@ -63764,6 +65078,13 @@ components: - 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 actor: title: Actor description: Actor @@ -66806,8 +68127,8 @@ components: code-scanning-ref: type: string description: |- - The full Git reference, formatted as `refs/heads/`, - `refs/pull//merge`, or `refs/pull//head`. + The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + `refs/heads/` or simply ``. code-scanning-analysis-analysis-key: type: string description: Identifies the configuration under which the analysis was executed. @@ -67318,8 +68639,8 @@ components: - key_id - key copilot-seat-breakdown: - title: Copilot for Business Seat Breakdown - description: The breakdown of Copilot for Business seats for the organization. + title: Copilot Business Seat Breakdown + description: The breakdown of Copilot Business seats for the organization. type: object properties: total: @@ -67346,9 +68667,9 @@ components: description: The number of seats that have not used Copilot during the current billing cycle. copilot-organization-details: - title: Copilot for Business Organization Details + title: Copilot Business Organization Details description: Information about the seat breakdown and policies set for an organization - with a Copilot for Business subscription. + with a Copilot Business subscription. type: object properties: seat_breakdown: @@ -67669,9 +68990,9 @@ components: - created_at - updated_at copilot-seat-details: - title: Copilot for Business Seat Detail - description: Information about a Copilot for Business seat assignment for a - user, team, or organization. + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment for a user, + team, or organization. type: object properties: assignee: @@ -68175,6 +69496,59 @@ components: - url - created_at - updated_at + organization-fine-grained-permission: + title: Organization Fine-Grained Permission + description: A fine-grained permission that protects organization resources. + type: object + properties: + name: + type: string + description: + type: string + required: + - name + - description + organization-role: + title: Organization Role + description: Organization roles + type: object + properties: + id: + description: The unique identifier of the role. + type: integer + name: + description: The name of the role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + permissions: + description: A list of permissions included in this role. + type: array + items: + type: string + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + description: The date and time the role was created. + type: string + format: date-time + updated_at: + description: The date and time the role was last updated. + type: string + format: date-time + required: + - id + - name + - permissions + - organization + - created_at + - updated_at package-version: title: Package Version description: A version of a software package @@ -68507,6 +69881,88 @@ components: - columns_url - created_at - updated_at + org-custom-property: + title: Organization Custom Property + description: Custom property defined on an organization + type: object + properties: + property_name: + type: string + description: The name of the property + value_type: + type: string + enum: + - string + - single_select + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + type: + - string + - 'null' + description: Default value of the property + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + description: Ordered list of allowed values of the property + required: + - property_name + - value_type + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + type: + - string + - 'null' + description: The value assigned to the property + required: + - property_name + - value + org-repo-custom-property-values: + title: Organization Repository Custom Property Values + description: List of custom property values for a repository + type: object + properties: + repository_id: + type: integer + examples: + - 1296269 + repository_name: + type: string + examples: + - Hello-World + repository_full_name: + type: string + examples: + - octocat/Hello-World + properties: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + description: List of custom property names and associated values + required: + - repository_id + - repository_name + - repository_full_name + - properties repository-rule-enforcement: type: string description: The enforcement level of the ruleset. `evaluate` allows admins @@ -68527,7 +69983,8 @@ components: properties: actor_id: type: integer - description: The ID of the actor that can bypass a ruleset + description: The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. actor_type: type: string enum: @@ -68682,7 +70139,7 @@ components: repository-rule-required-deployments: title: required_deployments description: Choose which environments must be successfully deployed to before - refs can be merged into a branch that matches this rule. + refs can be pushed into a ref that matches this rule. type: object required: - type @@ -68772,10 +70229,9 @@ components: - context repository-rule-required-status-checks: title: required_status_checks - description: Choose which status checks must pass before branches can be merged - into a branch that matches this rule. When enabled, commits must first be - pushed to another branch, then merged or pushed directly to a ref that matches - this rule after status checks have passed. + 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. type: object required: - type @@ -68879,9 +70335,43 @@ components: required: - operator - pattern - repository-rule-committer-email-pattern: - title: committer_email_pattern - description: Parameters to be used for the committer_email_pattern rule + repository-rule-committer-email-pattern: + title: committer_email_pattern + description: Parameters to be used for the committer_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - committer_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-branch-name-pattern: + title: branch_name_pattern + description: Parameters to be used for the branch_name_pattern rule type: object required: - type @@ -68889,7 +70379,7 @@ components: type: type: string enum: - - committer_email_pattern + - branch_name_pattern parameters: type: object properties: @@ -68913,9 +70403,9 @@ components: required: - operator - pattern - repository-rule-branch-name-pattern: - title: branch_name_pattern - description: Parameters to be used for the branch_name_pattern rule + repository-rule-tag-name-pattern: + title: tag_name_pattern + description: Parameters to be used for the tag_name_pattern rule type: object required: - type @@ -68923,7 +70413,7 @@ components: type: type: string enum: - - branch_name_pattern + - tag_name_pattern parameters: type: object properties: @@ -68947,9 +70437,30 @@ components: required: - operator - pattern - repository-rule-tag-name-pattern: - title: tag_name_pattern - description: Parameters to be used for the tag_name_pattern rule + repository-rule-params-workflow-file-reference: + title: WorkflowFileReference + description: A workflow that must run for this rule to pass + type: object + properties: + path: + type: string + description: The path to the workflow file + ref: + type: string + description: The ref (branch or tag) of the workflow file to use + repository_id: + type: integer + description: The ID of the repository where the workflow is defined + sha: + type: string + description: The commit SHA of the workflow file to use + required: + - path + - repository_id + repository-rule-workflows: + title: workflows + description: Require all changes made to a targeted branch to pass the specified + workflows before they can be merged. type: object required: - type @@ -68957,30 +70468,17 @@ components: type: type: string enum: - - tag_name_pattern + - workflows parameters: type: object properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. + workflows: + type: array + description: Workflows that must pass for this rule to pass. + items: + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" required: - - operator - - pattern + - workflows repository-rule: title: Repository Rule type: object @@ -69000,6 +70498,7 @@ 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" + - "$ref": "#/components/schemas/repository-rule-workflows" repository-ruleset: title: Repository ruleset type: object @@ -69300,7 +70799,9 @@ components: description: The Common Vulnerabilities and Exposures (CVE) ID. url: type: string + format: uri description: The API URL for the advisory. + readOnly: true html_url: type: string format: uri @@ -70086,7 +71587,7 @@ components: - true private: description: Whether or not this discussion should be restricted to team - members and organization administrators. + members and organization owners. type: boolean examples: - true @@ -70716,10 +72217,6 @@ components: type: boolean examples: - true - template_repository: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/repository" temp_clone_token: type: string allow_squash_merge: @@ -71796,6 +73293,7 @@ components: - queued - in_progress - completed + - waiting examples: - queued conclusion: @@ -74670,8 +76168,8 @@ components: type: - string - 'null' - description: The commit SHA of the CodeQL databases repository at time of - database creation. + description: The commit SHA of the repository at the time the CodeQL database + was created. required: - id - name @@ -74735,8 +76233,7 @@ components: type: object properties: state: - description: Whether code scanning default setup has been configured or - not. + description: The desired state of code scanning default setup. type: string enum: - configured @@ -74761,8 +76258,7 @@ components: - python - ruby - swift - required: - - state + additionalProperties: false code-scanning-default-setup-update-response: description: |- You can use `run_url` to track the status of the run. This includes a property status and conclusion. @@ -74775,6 +76271,14 @@ components: run_url: description: URL of the corresponding run. type: string + code-scanning-ref-full: + type: string + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. + pattern: "^refs/(heads|pull)/.*$" + examples: + - refs/heads/main code-scanning-analysis-sarif-file: 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) @@ -77238,11 +78742,11 @@ components: - false deployment-branch-policy: title: Deployment branch policy - description: Details of a deployment branch policy. + description: Details of a deployment branch or tag policy. type: object properties: id: - description: The unique identifier of the branch policy. + description: The unique identifier of the branch or tag policy. type: integer examples: - 361471 @@ -77251,24 +78755,40 @@ components: examples: - MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= name: - description: The name pattern that branches must match in order to deploy - to the environment. + description: The name pattern that branches or tags must match in order + to deploy to the environment. type: string examples: - release/* + type: + description: Whether this rule targets a branch or tag. + type: string + enum: + - branch + - tag + examples: + - branch deployment-branch-policy-name-pattern-with-type: - title: Deployment branch policy name pattern + title: Deployment branch and tag policy name pattern type: object properties: name: description: |- - The name pattern that branches must match in order to deploy to the environment. + The name pattern that branches or tags must match in order to deploy to the environment. Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. 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). type: string examples: - release/* + type: + description: Whether this rule targets a branch or tag + type: string + enum: + - branch + - tag + examples: + - branch required: - name deployment-branch-policy-name-pattern: @@ -82030,6 +83550,9 @@ components: - allOf: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" secret-scanning-alert: type: object properties: @@ -82095,6 +83618,13 @@ components: format: date-time description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown 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`. @@ -85197,6 +86727,12 @@ components: type: array items: type: string + 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 has_issues: description: Whether issues are enabled. default: true @@ -90945,6 +92481,112 @@ components: - pusher_type - repository - sender + webhook-custom-property-created: + title: custom property created event + type: object + properties: + action: + type: string + enum: + - created + definition: + "$ref": "#/components/schemas/org-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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-deleted: + title: custom property deleted event + type: object + properties: + action: + type: string + enum: + - deleted + definition: + type: object + properties: + property_name: + type: string + description: The name of the property that was deleted. + required: + - property_name + 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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-updated: + title: custom property updated event + type: object + properties: + action: + type: string + enum: + - updated + definition: + "$ref": "#/components/schemas/org-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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-values-updated: + title: Custom property values updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + repository: + "$ref": "#/components/schemas/repository-webhooks" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + new_property_values: + type: array + description: The new custom property values for the repository. + items: + "$ref": "#/components/schemas/custom-property-value" + old_property_values: + type: array + description: The old custom property values for the repository. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - action + - repository + - organization + - new_property_values + - old_property_values webhook-delete: title: delete event type: object @@ -98512,6 +100154,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -113798,6 +115446,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -118136,6 +119790,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -191628,6 +193288,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -199944,6 +201610,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -200540,6 +202212,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -201137,6 +202815,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -201798,6 +203482,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -202396,6 +204086,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -208675,10 +210371,7 @@ components: ## Attribution - This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - - [homepage]: http://contributor-covenant.org - [version]: http://contributor-covenant.org/version/1/4/ + 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/). html_url: http://contributor-covenant.org/version/1/4/ emojis-get: value: @@ -210973,6 +212666,7 @@ components: push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment + validity: active - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -211054,6 +212748,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: resolution_comment: + validity: unknown public-events-items: value: - id: '22249084947' @@ -214836,6 +216531,96 @@ components: status: enabled secret_scanning_push_protection: status: disabled + organization-fine-grained-permission-example: + value: + - name: read_organization_custom_org_role + description: View organization roles + - name: write_organization_custom_org_role + description: Manage custom organization roles + organization-role-list: + value: + total_count: 2 + roles: + - id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + 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 + site_admin: false + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + - id: 8031 + name: Auditor + description: Permissions to read the organization audit log + permissions: + - read_audit_logs + organization: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + 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 + site_admin: false + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + organization-role: + value: + id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + 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 + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' package-org: value: id: 197 @@ -215035,6 +216820,55 @@ components: site_admin: false created_at: '2011-04-11T20:09:31Z' updated_at: '2014-03-04T18:58:10Z' + org-custom-properties: + value: + - property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + - property_name: service + value_type: string + - property_name: team + value_type: string + description: Team owning the repository + org-custom-property: + value: + property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + org-repo-custom-property-values: + value: + - repository_id: 1296269 + repository_name: Hello-World + repository_full_name: octocat/Hello-World + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + org-repo-update-custom-property-values: + value: + repository_names: + - Hello-World + - octo-repo + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat repository: value: id: 1296269 @@ -215419,6 +217253,7 @@ components: repositories_url: https://api.github.com/teams/1/repos permission: admin parent: + private_fork: - ghsa_id: GHSA-1234-5678-9012 cve_id: CVE-2051-0000 url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 @@ -215476,7 +217311,7 @@ components: closed_at: withdrawn_at: submission: - - accepted: true + accepted: true vulnerabilities: - package: ecosystem: pip @@ -215558,6 +217393,71 @@ components: repositories_url: https://api.github.com/teams/1/repos permission: admin parent: + private_fork: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo-ghsa-1234-5678-9012 + full_name: octo-org/octo-repo-ghsa-1234-5678-9012 + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo-ghsa-1234-5678-9012 + description: + fork: false + url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012 + archive_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number} + commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha} + compare_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors + deployments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments + downloads_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads + events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events + forks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks + git_commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number} + keys_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name} + languages_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages + merges_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges + milestones_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers + statuses_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription + 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 @@ -216142,125 +218042,6 @@ components: pull: true role_name: read allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - 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-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - triage: false - push: false - maintain: false - admin: false - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false @@ -217689,6 +219470,7 @@ components: check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: master head_sha: acb5820ced9479c074f688cc328bf03f341a511d + path: ".github/workflows/build.yml@main" run_number: 562 event: push display_title: Update README.md @@ -220281,7 +222063,7 @@ components: created_at: '2022-09-12T12:14:32Z' updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java - commit_oid: 12345678901234567890 + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - id: 2 name: database.zip language: ruby @@ -220309,7 +222091,7 @@ components: created_at: '2022-09-12T12:14:32Z' updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby - commit_oid: 23456789012345678901 + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c code-scanning-codeql-database: value: id: 1 @@ -220339,7 +222121,7 @@ components: created_at: '2022-09-12T12:14:32Z' updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java - commit_oid: 12345678901234567890 + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c code-scanning-default-setup: value: state: configured @@ -223162,6 +224944,12 @@ components: id: 364663 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= name: main + deployment-branch-policy-single-tag: + value: + id: 364663 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= + name: v1 + type: tag deployment-protection-rules: value: - total_count: 2 @@ -225172,6 +226960,14 @@ components: site_admin: false created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -227524,6 +229320,7 @@ components: push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment + validity: inactive - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -227540,6 +229337,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: resolution_comment: + validity: unknown secret-scanning-alert-open: value: number: 42 @@ -227558,6 +229356,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: resolution_comment: + validity: unknown secret-scanning-alert-resolved: value: number: 42 @@ -227594,6 +229393,7 @@ components: push_protection_bypassed_by: push_protection_bypassed_at: resolution_comment: Example comment + validity: unknown secret-scanning-location-list: value: - type: commit @@ -227756,6 +229556,71 @@ components: repositories_url: https://api.github.com/teams/1/repos permission: admin parent: + private_fork: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo-ghsa-abcd-1234-efgh + full_name: octo-org/octo-repo-ghsa-abcd-1234-efgh + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh + description: + fork: false + url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh + archive_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number} + commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha} + compare_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors + deployments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments + downloads_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads + events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events + forks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks + git_commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number} + keys_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name} + languages_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages + merges_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges + milestones_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers + statuses_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription + tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags + teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams + trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} repository-advisory-pvr: value: ghsa_id: GHSA-abcd-1234-efgh @@ -227870,6 +229735,7 @@ components: repositories_url: https://api.github.com/teams/1/repos permission: admin parent: + private_fork: simple-user-items-default-response: summary: Default response value: @@ -229326,125 +231192,6 @@ components: pull: true role_name: read allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - 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-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - triage: false - push: false - maintain: false - admin: false - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false @@ -233932,6 +235679,15 @@ components: - 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 + schema: + type: string gist-id: name: gist_id description: The unique identifier of the gist. @@ -234148,6 +235904,20 @@ 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. + in: path + required: true + schema: + type: integer package-visibility: name: visibility description: |- @@ -234262,6 +236032,13 @@ components: required: true schema: type: integer + custom-property-name: + name: custom_property_name + description: The custom property name. The name is case sensitive. + in: path + required: true + schema: + type: string repository-name-in-query: name: repository_name description: The name of the repository to filter on. When specified, only rule @@ -234334,13 +236111,6 @@ components: required: false schema: type: string - team-slug: - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string discussion-number: name: discussion_number description: The number that identifies the discussion. diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index d0fce10fd..323485cb1 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -724,7 +724,7 @@ export interface paths { * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * 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. */ get: operations["gists/list-public"]; put?: never; @@ -2274,8 +2274,6 @@ export interface paths { * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. * * For public repositories, you may instead use the `public_repo` scope. - * - * GitHub Apps must have the `security_events` read permission to use this endpoint. */ get: operations["code-scanning/list-alerts-for-org"]; put?: never; @@ -2297,7 +2295,7 @@ export interface paths { * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. */ get: operations["codespaces/list-in-organization"]; put?: never; @@ -2320,7 +2318,7 @@ export interface paths { * 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. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ put: operations["codespaces/set-codespaces-access"]; post?: never; @@ -2347,7 +2345,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ post: operations["codespaces/set-codespaces-access-users"]; /** @@ -2358,7 +2356,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. */ delete: operations["codespaces/delete-codespaces-access-users"]; options?: never; @@ -2375,7 +2373,7 @@ export interface paths { }; /** * List organization secrets - * @description Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. + * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-org-secrets"]; @@ -2416,13 +2414,13 @@ export interface paths { }; /** * Get an organization secret - * @description Gets an organization secret without revealing its encrypted value. + * @description Gets an organization development environment secret without revealing its encrypted value. * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-secret"]; /** * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using + * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * You must authenticate using an access @@ -2432,7 +2430,7 @@ export interface paths { post?: never; /** * Delete an organization secret - * @description Deletes an organization secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-org-secret"]; options?: never; @@ -2454,7 +2452,7 @@ export interface paths { get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-selected-repos-for-org-secret"]; post?: never; @@ -2474,13 +2472,13 @@ export interface paths { get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @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). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ 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 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). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/remove-selected-repo-from-org-secret"]; options?: never; @@ -2496,14 +2494,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot for Business seat information and settings for an organization + * Get Copilot Business seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot for Business subscription, including seat breakdown + * Gets information about an organization's Copilot Business subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; @@ -2523,12 +2521,12 @@ export interface paths { cookie?: never; }; /** - * List all Copilot for Business seat assignments for an organization + * List all Copilot Business seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; @@ -2550,30 +2548,30 @@ export interface paths { get?: never; put?: never; /** - * Add teams to the Copilot for Business subscription for an organization + * Add teams to the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot for Business seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Purchases a GitHub Copilot Business seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. * - * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". */ post: operations["copilot/add-copilot-for-business-seats-for-teams"]; /** - * Remove teams from the Copilot for Business subscription for an organization + * Remove teams from the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for all members of each team specified. + * Cancels the Copilot Business seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -2594,30 +2592,30 @@ export interface paths { get?: never; put?: never; /** - * Add users to the Copilot for Business subscription for an organization + * Add users to the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot for Business seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + * Purchases a GitHub Copilot Business seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. * - * In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". */ post: operations["copilot/add-copilot-for-business-seats-for-users"]; /** - * Remove users from the Copilot for Business subscription for an organization + * Remove users from the Copilot Business subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot for Business seat assignment for each user specified. + * Cancels the Copilot Business seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" * - * For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -3074,7 +3072,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["orgs/create-invitation"]; delete?: never; @@ -3205,7 +3204,7 @@ export interface paths { * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. */ get: operations["codespaces/get-codespaces-for-user-in-org"]; put?: never; @@ -3230,7 +3229,10 @@ export interface paths { * Delete a codespace from the organization * @description Deletes a user's codespace. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * To use this endpoint you must authenticate using one of the following methods: + * + * - An access token with the `admin:org` scope + * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` */ delete: operations["codespaces/delete-from-organization"]; options?: never; @@ -3251,7 +3253,10 @@ export interface paths { * Stop a codespace for an organization user * @description Stops a user's codespace. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * To use this endpoint you must authenticate using one of the following methods: + * + * - An access token with the `admin:org` scope + * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` */ post: operations["codespaces/stop-in-organization"]; delete?: never; @@ -3268,14 +3273,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot for Business seat assignment details for a user + * Get Copilot Business seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - get: operations["copilot/get-copilot-seat-assignment-details-for-user"]; + get: operations["copilot/get-copilot-seat-details-for-user"]; put?: never; post?: never; delete?: never; @@ -3439,6 +3444,306 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/organization-fine-grained-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List organization fine-grained permissions for an organization + * @description **Note**: This operation is in beta and subject to change. + * + * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all organization roles for an organization + * @description Lists the organization roles available in this organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + get: operations["orgs/list-org-roles"]; + put?: never; + /** + * Create a custom organization role + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + post: operations["orgs/create-custom-organization-role"]; + 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. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/revoke-all-org-roles-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Assign an organization role to a team + * @description Assigns an organization role to a team in an organization. + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + 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. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/revoke-org-role-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove all organization roles for a user + * @description Revokes all assigned organization roles from a user. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/revoke-all-org-roles-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Assign an organization role to a user + * @description Assigns an organization role to a member of an organization. + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + 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. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/revoke-org-role-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an organization role + * @description Gets an organization role that is available to this organization. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + get: operations["orgs/get-org-role"]; + put?: never; + post?: never; + /** + * Delete a custom organization role. + * @description Deletes a custom organization role. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + delete: operations["orgs/delete-custom-organization-role"]; + options?: never; + head?: never; + /** + * Update a custom organization role + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. + * + * To use this endpoint, the authenticated user must be one of: + * + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * + * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + * + * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + patch: operations["orgs/patch-custom-organization-role"]; + trace?: 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 + * @description Lists the teams that are assigned to an organization role. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + get: operations["orgs/list-org-role-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: 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 + * @description Lists organization members that are assigned to an organization role. + * + * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * GitHub Apps must have the `members` organization read permission to use this endpoint. + * + * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + */ + get: operations["orgs/list-org-role-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/outside_collaborators": { parameters: { query?: never; @@ -3819,6 +4124,95 @@ export interface paths { 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. + * You must be an organization owner to use this endpoint. + */ + get: operations["orgs/get-all-custom-properties"]; + 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. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + patch: operations["orgs/create-or-update-custom-properties"]; + trace?: 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. + * You must be an organization owner to use this endpoint. + */ + get: operations["orgs/get-custom-property"]; + /** + * 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. + * You must be an organization owner to use this endpoint. + */ + put: operations["orgs/create-or-update-custom-property"]; + post?: never; + /** + * Remove a custom property for an organization + * @description Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + delete: operations["orgs/remove-custom-property"]; + options?: never; + head?: never; + patch?: never; + trace?: 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. + */ + get: operations["orgs/list-custom-properties-values-for-repos"]; + 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. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + trace?: never; + }; "/orgs/{org}/public_members": { parameters: { query?: never; @@ -4251,7 +4645,7 @@ export interface paths { * Create a discussion * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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`. */ @@ -4315,7 +4709,7 @@ export interface paths { * Create a discussion comment * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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`. */ @@ -4650,6 +5044,8 @@ export interface paths { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * + * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; @@ -7159,9 +7555,6 @@ export interface paths { * * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. * - * GitHub Apps must have the `security_events` read - * permission to use this endpoint. - * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if you used `ref` in the request). @@ -7184,7 +7577,7 @@ export interface paths { }; /** * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. */ get: operations["code-scanning/get-alert"]; put?: never; @@ -7194,7 +7587,7 @@ export interface paths { head?: never; /** * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. */ patch: operations["code-scanning/update-alert"]; trace?: never; @@ -7211,7 +7604,6 @@ export interface paths { * @description Lists all instances of the specified code scanning alert. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. */ get: operations["code-scanning/list-alert-instances"]; put?: never; @@ -7244,7 +7636,6 @@ export interface paths { * * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. @@ -7270,7 +7661,6 @@ export interface paths { * @description Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint with private repos, * the `public_repo` scope also grants permission to read security events on public repos only. - * GitHub Apps must have the `security_events` read permission to use this endpoint. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -7377,7 +7767,6 @@ export interface paths { * * For private repositories, you must use an access token with the `security_events` scope. * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. */ get: operations["code-scanning/list-codeql-databases"]; put?: never; @@ -7407,7 +7796,6 @@ export interface paths { * * For private repositories, you must use an access token with the `security_events` scope. * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - * GitHub Apps must have the `contents` read permission to use this endpoint. */ get: operations["code-scanning/get-codeql-database"]; put?: never; @@ -7429,7 +7817,7 @@ export interface paths { * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * scope for public repos. */ get: operations["code-scanning/get-default-setup"]; put?: never; @@ -7441,7 +7829,7 @@ export interface paths { * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + * scope for public repos. */ patch: operations["code-scanning/update-default-setup"]; trace?: never; @@ -7504,7 +7892,7 @@ export interface paths { }; /** * 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)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. GitHub Apps must have the `security_events` read permission to use this endpoint. + * @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)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. */ get: operations["code-scanning/get-sarif"]; put?: never; @@ -7677,7 +8065,7 @@ export interface paths { }; /** * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ get: operations["codespaces/list-repo-secrets"]; put?: never; @@ -7717,12 +8105,12 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ get: operations["codespaces/get-repo-secret"]; /** * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using + * @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)." * * You must authenticate using an access @@ -7733,7 +8121,7 @@ export interface paths { post?: never; /** * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. */ delete: operations["codespaces/delete-repo-secret"]; options?: never; @@ -7788,7 +8176,7 @@ 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." * @@ -8041,7 +8429,7 @@ export interface paths { * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["repos/create-commit-comment"]; delete?: never; @@ -8848,7 +9236,7 @@ export interface paths { put?: never; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -8868,14 +9256,14 @@ export interface paths { }; /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -8883,7 +9271,7 @@ export interface paths { post?: never; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -9580,11 +9968,10 @@ export interface paths { }; /** * Get an import status + * @deprecated * @description View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -9622,18 +10009,22 @@ export interface paths { get: operations["migrations/get-import-status"]; /** * Start an import - * @description Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * @deprecated + * @description Start a source import to a GitHub repository using GitHub Importer. + * Importing into a GitHub repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * */ put: operations["migrations/start-import"]; post?: never; /** * Cancel an import + * @deprecated * @description Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ delete: operations["migrations/cancel-import"]; @@ -9641,6 +10032,7 @@ export interface paths { head?: never; /** * Update an import + * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. * @@ -9648,9 +10040,7 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; trace?: never; @@ -9664,13 +10054,12 @@ export interface paths { }; /** * Get commit authors + * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; put?: never; @@ -9696,12 +10085,11 @@ export interface paths { head?: never; /** * Map a commit author + * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ patch: operations["migrations/map-commit-author"]; @@ -9716,11 +10104,10 @@ export interface paths { }; /** * Get large files + * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ get: operations["migrations/get-large-files"]; @@ -9747,15 +10134,14 @@ export interface paths { head?: never; /** * Update Git LFS preference + * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability * is powered by [Git LFS](https://git-lfs.com). * * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * */ patch: operations["migrations/set-lfs-preference"]; @@ -9871,7 +10257,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["issues/create"]; delete?: never; @@ -10120,9 +10507,8 @@ 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. - * See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" - * and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" - * for details. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/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)." */ post: operations["issues/create-comment"]; delete?: never; @@ -10767,6 +11153,27 @@ export interface paths { patch?: never; trace?: 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. + */ + get: operations["repos/get-custom-properties-values"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/pulls": { parameters: { query?: never; @@ -10786,7 +11193,7 @@ export interface paths { * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + * 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/overview/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)." */ post: operations["pulls/create"]; delete?: never; @@ -10975,7 +11382,8 @@ export interface paths { * * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. * - * This endpoint 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["pulls/create-review-comment"]; delete?: never; @@ -10997,7 +11405,8 @@ export interface paths { * 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. * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["pulls/create-reply-for-review-comment"]; delete?: never; @@ -11061,7 +11470,7 @@ export interface paths { /** * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ put: operations["pulls/merge"]; post?: never; @@ -11087,7 +11496,7 @@ export interface paths { /** * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["pulls/request-reviewers"]; /** @@ -11115,7 +11524,7 @@ export interface paths { put?: never; /** * Create a review for a pull request - * @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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * @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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * @@ -11301,7 +11710,7 @@ export interface paths { * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["repos/create-release"]; delete?: never; @@ -12540,7 +12949,7 @@ export interface paths { }; /** * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12579,7 +12988,7 @@ export interface paths { }; /** * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match * metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -12606,7 +13015,7 @@ export interface paths { }; /** * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -12637,7 +13046,7 @@ export interface paths { }; /** * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12665,7 +13074,7 @@ export interface paths { }; /** * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12693,7 +13102,7 @@ export interface paths { }; /** * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12721,7 +13130,7 @@ export interface paths { }; /** * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * @@ -12804,7 +13213,7 @@ export interface paths { * * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["teams/create-discussion-legacy"]; delete?: never; @@ -12873,7 +13282,7 @@ export interface paths { * * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + * 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/overview/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)." */ post: operations["teams/create-discussion-comment-legacy"]; delete?: never; @@ -13394,7 +13803,7 @@ export interface paths { }; /** * List secrets for the authenticated user - * @description Lists all secrets available for a user's Codespaces without revealing their + * @description Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -13443,7 +13852,7 @@ export interface paths { }; /** * Get a secret for the authenticated user - * @description Gets a secret available to a user's codespaces without revealing its encrypted value. + * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13452,7 +13861,7 @@ export interface paths { get: operations["codespaces/get-secret-for-authenticated-user"]; /** * Create or update a secret for the authenticated user - * @description Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -13463,7 +13872,7 @@ export interface paths { post?: never; /** * Delete a secret for the authenticated user - * @description Deletes a 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. + * @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. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13484,7 +13893,7 @@ export interface paths { }; /** * List selected repositories for a user secret - * @description List the repositories that have been granted the ability to use a user's codespace secret. + * @description List the repositories that have been granted the ability to use a user's development environment secret. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13493,7 +13902,7 @@ export interface paths { 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 codespace secret. + * @description Select the repositories that will use a user's development environment secret. * * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * @@ -13517,7 +13926,7 @@ export interface paths { get?: never; /** * Add a selected repository to a user secret - * @description Adds a repository to the selected repositories for a user's codespace secret. + * @description Adds a repository to the selected repositories for a user's development environment secret. * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. */ @@ -13525,7 +13934,7 @@ export interface paths { post?: never; /** * Remove a selected repository from a user secret - * @description Removes a repository from the selected repositories for a user's codespace secret. + * @description Removes a repository from the selected repositories for a user's development environment secret. * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. */ @@ -16333,6 +16742,11 @@ export interface components { * @enum {string} */ organization_custom_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom property management. + * @enum {string} + */ + organization_custom_properties?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} @@ -17487,10 +17901,7 @@ export interface components { * * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - * - * [homepage]: http://contributor-covenant.org - * [version]: http://contributor-covenant.org/version/1/4/ + * 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/). * */ body?: string; /** Format: uri */ @@ -17952,6 +18363,11 @@ export interface components { push_protection_bypassed_at?: 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"; }; /** * Actor @@ -19739,8 +20155,8 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** @description The full Git reference, formatted as `refs/heads/`, - * `refs/pull//merge`, or `refs/pull//head`. */ + /** @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; @@ -20048,8 +20464,8 @@ export interface components { created_at?: string; }; /** - * Copilot for Business Seat Breakdown - * @description The breakdown of Copilot for Business seats for the organization. + * Copilot Business Seat Breakdown + * @description The breakdown of Copilot Business seats for the organization. */ "copilot-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ @@ -20066,8 +20482,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot for Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot for Business subscription. + * Copilot Business Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -20263,8 +20679,8 @@ export interface components { }; }; /** - * Copilot for Business Seat Detail - * @description Information about a Copilot for Business seat assignment for a user, team, or organization. + * Copilot Business Seat Detail + * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { /** @description The assignee that has been granted access to GitHub Copilot. */ @@ -20773,6 +21189,39 @@ export interface components { /** @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"`. */ exclude?: string[]; }; + /** + * Organization Fine-Grained Permission + * @description A fine-grained permission that protects organization resources. + */ + "organization-fine-grained-permission": { + name: string; + description: string; + }; + /** + * Organization Role + * @description Organization roles + */ + "organization-role": { + /** @description The unique identifier of the role. */ + id: number; + /** @description The name of the role. */ + name: string; + /** @description A short description about who this role is for or what permissions it grants. */ + description?: string | null; + /** @description A list of permissions included in this role. */ + permissions: string[]; + organization: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The date and time the role was created. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the role was last updated. + */ + updated_at: string; + }; /** * Package Version * @description A version of a software package @@ -20968,6 +21417,52 @@ export interface components { /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ private?: boolean; }; + /** + * Organization Custom Property + * @description Custom property defined on an organization + */ + "org-custom-property": { + /** @description The name of the property */ + property_name: string; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | null; + /** @description Short description of the property */ + description?: string | null; + /** @description Ordered list of allowed values of the property */ + allowed_values?: string[] | null; + }; + /** + * Custom Property Value + * @description Custom property name and associated value + */ + "custom-property-value": { + /** @description The name of the property */ + property_name: string; + /** @description The value assigned to the property */ + value: string | null; + }; + /** + * Organization Repository Custom Property Values + * @description List of custom property values for a repository + */ + "org-repo-custom-property-values": { + /** @example 1296269 */ + repository_id: number; + /** @example Hello-World */ + repository_name: string; + /** @example octocat/Hello-World */ + repository_full_name: string; + /** @description List of custom property names and associated values */ + properties: components["schemas"]["custom-property-value"][]; + }; /** * @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} @@ -20978,7 +21473,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 */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ actor_id: number; /** * @description The type of actor that can bypass a ruleset @@ -21071,7 +21566,7 @@ export interface components { }; /** * required_deployments - * @description Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule. + * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. */ "repository-rule-required-deployments": { /** @enum {string} */ @@ -21121,7 +21616,7 @@ export interface components { }; /** * required_status_checks - * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed. + * @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. */ "repository-rule-required-status-checks": { /** @enum {string} */ @@ -21246,11 +21741,37 @@ export interface components { pattern: string; }; }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + ref?: string; + /** @description The ID of the repository where the workflow is defined */ + repository_id: number; + /** @description The commit SHA of the workflow file to use */ + sha?: string; + }; + /** + * workflows + * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + */ + "repository-rule-workflows": { + /** @enum {string} */ + type: "workflows"; + parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; /** * 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-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": 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-workflows"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -21429,8 +21950,11 @@ export interface components { readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ cve_id: string | null; - /** @description The API URL for the advisory. */ - url: string; + /** + * Format: uri + * @description The API URL for the advisory. + */ + readonly url: string; /** * Format: uri * @description The URL for the advisory. @@ -21899,7 +22423,7 @@ export interface components { */ pinned: boolean; /** - * @description Whether or not this discussion should be restricted to team members and organization administrators. + * @description Whether or not this discussion should be restricted to team members and organization owners. * @example true */ private: boolean; @@ -22050,10 +22574,10 @@ export interface components { }; }; /** - * Repository - * @description A repository on GitHub. + * Team Repository + * @description A team's access to a repository. */ - "nullable-repository": { + "team-repository": { /** * @description Unique identifier of the repository * @example 42 @@ -22069,7 +22593,6 @@ export interface components { /** @example octocat/Hello-World */ full_name: string; license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; forks: number; permissions?: { admin: boolean; @@ -22078,7 +22601,9 @@ export interface components { push: boolean; maintain?: boolean; }; - owner: components["schemas"]["simple-user"]; + /** @example admin */ + role_name?: string; + owner: components["schemas"]["nullable-simple-user"]; /** * @description Whether the repository is private or public. * @default false @@ -22236,10 +22761,7 @@ export interface components { stargazers_count: number; /** @example 80 */ watchers_count: number; - /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 - */ + /** @example 108 */ size: number; /** * @description The default branch of the repository. @@ -22275,18 +22797,11 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** - * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ has_downloads: boolean; - /** - * @description Whether discussions are enabled. - * @default false - * @example true - */ - has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -22320,150 +22835,6 @@ export interface components { * @example true */ 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: - * - * - `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 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"; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -22484,79 +22855,164 @@ export interface components { */ 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. + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow forking this repo * @default false * @example false */ - allow_update_branch: boolean; + allow_forking: boolean; /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Whether to require contributors to sign off on web-based commits * @default false + * @example false */ - use_squash_pr_title_as_default: boolean; + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; + }; + /** + * Project Card + * @description Project cards represent a scope of work. + */ + "project-card": { /** - * @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} + * Format: uri + * @example https://api.github.com/projects/columns/cards/1478 */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + url: string; /** - * @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} + * @description The project card's ID + * @example 42 */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + id: number; + /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ + node_id: string; + /** @example Add payload for delete Project column */ + note: string | null; + creator: components["schemas"]["nullable-simple-user"]; /** - * @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} + * Format: date-time + * @example 2016-09-05T14:21:06Z */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + created_at: 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} + * Format: date-time + * @example 2016-09-05T14:20:22Z */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + updated_at: string; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true + * @description Whether or not the card is archived + * @example false */ - allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - allow_forking?: boolean; + archived?: boolean; + column_name?: string; + project_id?: string; /** - * @description Whether to require contributors to sign off on web-based commits - * @default false + * Format: uri + * @example https://api.github.com/projects/columns/367 */ - 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" */ - starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - anonymous_access_enabled?: boolean; - } | null; + 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; + }; /** - * Team Repository - * @description A team's access to a repository. + * Project Column + * @description Project columns contain cards of work. */ - "team-repository": { + "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; + remaining: number; + reset: number; + used: number; + }; + /** + * Rate Limit Overview + * @description Rate Limit Overview + */ + "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"]; + }; + rate: components["schemas"]["rate-limit"]; + }; + /** + * Repository + * @description A repository on GitHub. + */ + "nullable-repository": { /** * @description Unique identifier of the repository * @example 42 @@ -22572,6 +23028,7 @@ export interface components { /** @example octocat/Hello-World */ full_name: string; license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; forks: number; permissions?: { admin: boolean; @@ -22580,9 +23037,7 @@ export interface components { push: boolean; maintain?: boolean; }; - /** @example admin */ - role_name?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false @@ -22740,7 +23195,10 @@ export interface components { stargazers_count: number; /** @example 80 */ watchers_count: number; - /** @example 108 */ + /** + * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 + */ size: number; /** * @description The default branch of the repository. @@ -22776,11 +23234,18 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** + * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ has_downloads: boolean; + /** + * @description Whether discussions are enabled. + * @default false + * @example true + */ + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -22814,7 +23279,150 @@ export interface components { * @example true */ allow_rebase_merge: boolean; - template_repository?: components["schemas"]["nullable-repository"]; + 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: + * + * - `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 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"; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + } | null; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -22835,159 +23443,74 @@ export interface components { */ delete_branch_on_merge: boolean; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow forking this repo + * @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 */ - allow_forking: boolean; + allow_update_branch: boolean; /** - * @description Whether to require contributors to sign off on web-based commits + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false - * @example false */ - web_commit_signoff_required: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - 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; - /** - * @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; + use_squash_pr_title_as_default: boolean; /** - * Format: uri - * @example https://api.github.com/projects/120 + * @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} */ - project_url: string; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards + * @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} */ - cards_url: string; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The unique identifier of the project column - * @example 42 + * @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} */ - id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Name of the project column - * @example Remaining tasks + * @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} */ - name: string; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** - * Format: date-time - * @example 2016-09-05T14:18:44Z + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true */ - created_at: string; + allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + allow_forking?: boolean; /** - * Format: date-time - * @example 2016-09-05T14:22:28Z + * @description Whether to require contributors to sign off on web-based commits + * @default false */ - 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; - remaining: number; - reset: number; - used: number; - }; - /** - * Rate Limit Overview - * @description Rate Limit Overview - */ - "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"]; - }; - rate: components["schemas"]["rate-limit"]; - }; + 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" */ + starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + anonymous_access_enabled?: boolean; + } | null; /** * Code Of Conduct Simple * @description Code of Conduct Simple @@ -23428,7 +23951,7 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed" | "waiting"; /** * @description The outcome of the job. * @example success @@ -25082,7 +25605,7 @@ export interface components { * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. */ url: string; - /** @description The commit SHA of the CodeQL databases repository at time of database creation. */ + /** @description The commit SHA of the repository at the time the CodeQL database was created. */ commit_oid?: string | null; }; /** @description Configuration for code scanning default setup. */ @@ -25114,10 +25637,10 @@ export interface components { /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup-update": { /** - * @description Whether code scanning default setup has been configured or not. + * @description The desired state of code scanning default setup. * @enum {string} */ - state: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** * @description CodeQL query suite to be used. * @enum {string} @@ -25134,6 +25657,12 @@ export interface components { /** @description URL of the corresponding run. */ run_url?: string; }; + /** + * @description The full Git reference, formatted as `refs/heads/`, + * `refs/pull//merge`, or `refs/pull//head`. + * @example refs/heads/main + */ + "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)." */ "code-scanning-analysis-sarif-file": string; "code-scanning-sarifs-receipt": { @@ -26555,32 +27084,44 @@ export interface components { "prevent-self-review": boolean; /** * Deployment branch policy - * @description Details of a deployment branch policy. + * @description Details of a deployment branch or tag policy. */ "deployment-branch-policy": { /** - * @description The unique identifier of the branch policy. + * @description The unique identifier of the branch or tag policy. * @example 361471 */ id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ node_id?: string; /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ name?: string; + /** + * @description Whether this rule targets a branch or tag. + * @example branch + * @enum {string} + */ + type?: "branch" | "tag"; }; - /** Deployment branch policy name pattern */ + /** Deployment branch and tag policy name pattern */ "deployment-branch-policy-name-pattern-with-type": { /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. * 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/* */ name: string; + /** + * @description Whether this rule targets a branch or tag + * @example branch + * @enum {string} + */ + type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { @@ -29112,7 +29653,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-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"]); + "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-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"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -29149,6 +29690,11 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -30783,6 +31329,10 @@ export interface components { */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -31615,6 +32165,10 @@ export interface components { */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** * @description Whether issues are enabled. * @default true @@ -33885,6 +34439,53 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; + /** custom property created event */ + "webhook-custom-property-created": { + /** @enum {string} */ + action: "created"; + definition: components["schemas"]["org-custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property deleted event */ + "webhook-custom-property-deleted": { + /** @enum {string} */ + action: "deleted"; + definition: { + /** @description The name of the property that was deleted. */ + property_name: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property updated event */ + "webhook-custom-property-updated": { + /** @enum {string} */ + action: "updated"; + definition: components["schemas"]["org-custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Custom property values updated event */ + "webhook-custom-property-values-updated": { + /** @enum {string} */ + 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-webhooks"]; + /** @description The new custom property values for the repository. */ + new_property_values: components["schemas"]["custom-property-value"][]; + /** @description The old custom property values for the repository. */ + old_property_values: components["schemas"]["custom-property-value"][]; + }; /** delete event */ "webhook-delete": { enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -37263,6 +37864,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -44204,6 +44809,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -46170,6 +46779,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -82923,6 +83536,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -86675,6 +87292,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -86984,6 +87605,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -87293,6 +87918,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -87633,6 +88262,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -87942,6 +88575,10 @@ export interface components { /** Format: uri */ 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. */ + custom_properties?: { + [key: string]: unknown; + }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -90666,6 +91303,8 @@ export interface components { "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 The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -90722,6 +91361,10 @@ export interface components { "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; /** @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`. @@ -90747,6 +91390,8 @@ export interface components { "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; + /** @description The custom property name. The name is case sensitive. */ + "custom-property-name": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ "repository-name-in-query": number; /** @description The time period to filter by. @@ -90766,8 +91411,6 @@ export interface components { "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 The slug of the team name. */ - "team-slug": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -91907,6 +92550,8 @@ 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. */ 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"]; }; header?: never; path: { @@ -95477,7 +96122,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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; @@ -95520,7 +96165,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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; @@ -95563,7 +96208,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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; @@ -95606,7 +96251,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business 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. */ + /** @description Copilot Business 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; @@ -96890,7 +97535,7 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - "copilot/get-copilot-seat-assignment-details-for-user": { + "copilot/get-copilot-seat-details-for-user": { parameters: { query?: never; header?: never; @@ -96916,7 +97561,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot for Business is not enabled for this organization or the user has a pending organization invitation. */ + /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */ 422: { headers: { [name: string]: unknown; @@ -97261,6 +97906,451 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "orgs/list-organization-fine-grained-permissions": { + 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-fine-grained-permission"][]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/list-org-roles": { + 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 - list of organization roles */ + 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"][]; + }; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/create-custom-organization-role": { + 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 custom role. */ + name: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "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?: 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 Response */ + 204: { + headers: { + [name: string]: unknown; + }; + 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; + }; + }; + }; + "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 */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "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 handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "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 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: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @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; + }; + }; + }; + "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 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: { + 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 */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/delete-custom-organization-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: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "orgs/patch-custom-organization-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: { + content: { + "application/json": { + /** @description The name of the custom role. */ + name?: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + description?: string; + /** @description A list of additional permissions included in this role. */ + permissions?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "orgs/list-org-role-teams": { + parameters: { + query?: { + /** @description The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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"][]; + }; + }; + /** @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 The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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 users */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + /** @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-outside-collaborators": { parameters: { query?: { @@ -97986,6 +99076,220 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; + "orgs/get-all-custom-properties": { + 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"]["org-custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-or-update-custom-properties": { + 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. */ + properties: components["schemas"]["org-custom-property"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/get-custom-property": { + 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. The name is case sensitive. */ + 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"]["org-custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-or-update-custom-property": { + 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. The name is case sensitive. */ + custom_property_name: components["parameters"]["custom-property-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | null; + /** @description Short description of the property */ + description?: string | null; + /** @description Ordered list of allowed values of the property */ + allowed_values?: string[] | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/remove-custom-property": { + 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. The name is case sensitive. */ + 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"]; + }; + }; + "orgs/list-custom-properties-values-for-repos": { + parameters: { + query?: { + /** @description The number of results per page (max 100). */ + per_page?: components["parameters"]["per-page"]; + /** @description Page number of the results to fetch. */ + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-or-update-custom-properties-values-for-repos": { + 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 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 No Content when custom property values are successfully created or updated */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "orgs/list-public-members": { parameters: { query?: { @@ -98258,6 +99562,10 @@ export interface operations { * @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; + }; }; }; }; @@ -98542,6 +99850,8 @@ export interface operations { 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"]; }; header?: never; path: { @@ -105741,7 +107051,7 @@ export interface operations { content: { "application/json": { commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - ref: components["schemas"]["code-scanning-ref"]; + ref: components["schemas"]["code-scanning-ref-full"]; sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** * Format: uri @@ -111501,6 +112811,7 @@ export interface operations { "application/json": components["schemas"]["license-content"]; }; }; + 404: components["responses"]["not_found"]; }; }; "repos/merge-upstream": { @@ -112378,6 +113689,33 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; + "repos/get-custom-properties-values": { + 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"]["custom-property-value"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "pulls/list": { parameters: { query?: { @@ -114612,6 +115950,8 @@ export interface operations { 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"]; }; header?: never; path: { diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index 645d75672..9bc4eecaa 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -85,6 +85,8 @@ tags: description: Owner or admin management of users interactions. - name: classroom description: Interact with GitHub Classroom. +- name: desktop + description: Desktop specific endpoints. servers: - url: https://api.github.com externalDocs: @@ -1500,6 +1502,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" responses: '200': description: Response @@ -1734,7 +1737,7 @@ paths: description: |- List public gists sorted by most recently updated to least recently updated. - Note: With [pagination](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + 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. tags: - gists operationId: gists/list-public @@ -5745,8 +5748,6 @@ paths: To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. For public repositories, you may instead use the `public_repo` scope. - - GitHub Apps must have the `security_events` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/list-alerts-for-org @@ -5816,7 +5817,7 @@ paths: description: |- Lists the codespaces associated to a specified organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. tags: - codespaces operationId: codespaces/list-in-organization @@ -5867,7 +5868,7 @@ paths: summary: Manage access control for organization codespaces 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. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access @@ -5938,7 +5939,7 @@ paths: To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access-users @@ -5996,7 +5997,7 @@ paths: To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. tags: - codespaces operationId: codespaces/delete-codespaces-access-users @@ -6050,7 +6051,7 @@ paths: get: summary: List organization secrets description: |- - Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. + Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: - codespaces @@ -6124,7 +6125,7 @@ paths: get: summary: Get an organization secret description: |- - Gets an organization secret without revealing its encrypted value. + Gets an organization development environment secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: - codespaces @@ -6156,7 +6157,7 @@ paths: put: summary: Create or update an organization secret description: |- - Creates or updates an organization secret with an encrypted value. Encrypt your secret using + Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." You must authenticate using an access @@ -6242,9 +6243,9 @@ paths: subcategory: organization-secrets delete: summary: Delete an organization secret - description: Deletes an organization secret using the secret name. You must - authenticate using an access token with the `admin:org` scope to use this - endpoint. + description: Deletes an organization development environment secret using the + secret name. You must authenticate using an access token with the `admin:org` + scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-org-secret @@ -6310,9 +6311,9 @@ paths: subcategory: organization-secrets put: summary: Set selected repositories for an organization secret - description: Replaces all repositories for an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + description: Replaces all repositories for an organization development environment + secret when the `visibility` for repository access is set to `selected`. The + visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: @@ -6364,9 +6365,9 @@ paths: "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret - description: Adds a repository to an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-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). You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: @@ -6399,9 +6400,9 @@ paths: subcategory: organization-secrets delete: summary: Remove selected repository from an organization secret - description: Removes a repository from an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + description: Removes a repository from an organization development environment + secret when the `visibility` for repository access is set to `selected`. The + visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. tags: @@ -6434,22 +6435,22 @@ paths: subcategory: organization-secrets "/orgs/{org}/copilot/billing": get: - summary: Get Copilot for Business seat information and settings for an organization + summary: Get Copilot Business seat information and settings for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Gets information about an organization's Copilot for Business subscription, including seat breakdown + Gets information about an organization's Copilot Business subscription, including seat breakdown and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Configuring GitHub Copilot settings in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization)". + For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-information-and-settings-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#get-copilot-business-seat-information-and-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: @@ -6474,23 +6475,23 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/copilot/billing/seats": get: - summary: List all Copilot for Business seat assignments for an organization + summary: List all Copilot Business seat assignments for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). - Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must + Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#list-all-copilot-for-business-seat-assignments-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#list-all-copilot-business-seat-assignments-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/page" @@ -6534,28 +6535,28 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/copilot/billing/selected_teams": post: - summary: Add teams to the Copilot for Business subscription for an organization + summary: Add teams to the Copilot Business subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Purchases a GitHub Copilot for Business seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + Purchases a GitHub Copilot Business seat for all users within each specified team. + The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. - In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". tags: - copilot operationId: copilot/add-copilot-for-business-seats-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#add-teams-to-the-copilot-for-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#add-teams-to-the-copilot-business-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6607,26 +6608,26 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business 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 + description: Copilot Business 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. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business delete: - summary: Remove teams from the Copilot for Business subscription for an organization + summary: Remove teams from the Copilot Business subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Cancels the Copilot for Business seat assignment for all members of each team specified. + Cancels the Copilot Business seat assignment for all members of each team specified. This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". - For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -6635,7 +6636,7 @@ paths: operationId: copilot/cancel-copilot-seat-assignment-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#remove-teams-from-the-copilot-for-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#remove-teams-from-the-copilot-business-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6687,36 +6688,36 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business 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 + description: Copilot Business 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. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/copilot/billing/selected_users": post: - summary: Add users to the Copilot for Business subscription for an organization + summary: Add users to the Copilot Business subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Purchases a GitHub Copilot for Business seat for each user specified. - The organization will be billed accordingly. For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)". + Purchases a GitHub Copilot Business seat for each user specified. + The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. - In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. - For more information about setting up a Copilot for Business subscription, see "[Setting up a Copilot for Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-for-business-subscription-for-your-organization)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. + For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". + For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". tags: - copilot operationId: copilot/add-copilot-for-business-seats-for-users externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#add-users-to-the-copilot-for-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#add-users-to-the-copilot-business-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6768,26 +6769,26 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business 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 + description: Copilot Business 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. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business delete: - summary: Remove users from the Copilot for Business subscription for an organization + summary: Remove users from the Copilot Business subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Cancels the Copilot for Business seat assignment for each user specified. + Cancels the Copilot Business seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - For more information about Copilot for Business pricing, see "[About billing for GitHub Copilot for Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-for-business)" + For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" - For more information about disabling access to Copilot for Business, see "[Disabling access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/configuring-github-copilot/configuring-github-copilot-settings-in-your-organization#disabling-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. @@ -6796,7 +6797,7 @@ paths: operationId: copilot/cancel-copilot-seat-assignment-for-users externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#remove-users-from-the-copilot-for-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-business#remove-users-from-the-copilot-business-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6848,16 +6849,16 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business 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. + description: Copilot Business 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. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/dependabot/alerts": get: summary: List Dependabot alerts for an organization @@ -8101,7 +8102,8 @@ paths: description: |- Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - orgs operationId: orgs/create-invitation @@ -8449,7 +8451,7 @@ paths: description: |- Lists the codespaces that a member of an organization has for repositories in that organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. tags: - codespaces operationId: codespaces/get-codespaces-for-user-in-org @@ -8502,7 +8504,10 @@ paths: description: |- Deletes a user's codespace. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + To use this endpoint you must authenticate using one of the following methods: + + - An access token with the `admin:org` scope + - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` tags: - codespaces operationId: codespaces/delete-from-organization @@ -8537,7 +8542,10 @@ paths: description: |- Stops a user's codespace. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + To use this endpoint you must authenticate using one of the following methods: + + - An access token with the `admin:org` scope + - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` tags: - codespaces operationId: codespaces/stop-in-organization @@ -8575,19 +8583,19 @@ paths: subcategory: organizations "/orgs/{org}/members/{username}/copilot": get: - summary: Get Copilot for Business seat assignment details for a user + summary: Get Copilot Business seat assignment details for a user description: |- **Note**: This endpoint is in beta and is subject to change. - Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. tags: - copilot - operationId: copilot/get-copilot-seat-assignment-details-for-user + operationId: copilot/get-copilot-seat-details-for-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user + url: https://docs.github.com/rest/copilot/copilot-business#get-copilot-business-seat-assignment-details-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" @@ -8610,13 +8618,13 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot for Business is not enabled for this organization or - the user has a pending organization invitation. + description: Copilot Business is not enabled for this organization or the + user has a pending organization invitation. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-for-business + subcategory: copilot-business "/orgs/{org}/memberships/{username}": get: summary: Get organization membership for a user @@ -9053,6 +9061,633 @@ paths: enabledForGitHubApps: false category: migrations subcategory: orgs + "/orgs/{org}/organization-fine-grained-permissions": + get: + summary: List organization fine-grained permissions for an organization + description: |- + **Note**: This operation is in beta and subject to change. + + Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + tags: + - orgs + operationId: orgs/list-organization-fine-grained-permissions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-fine-grained-permission" + examples: + default: + "$ref": "#/components/examples/organization-fine-grained-permission-example" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles": + get: + summary: Get all organization roles for an organization + description: |- + Lists the organization roles available in this organization. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/list-org-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response - list of organization roles + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + description: The total number of organization roles available + to the organization. + roles: + type: array + description: The list of organization roles available to the organization. + items: + "$ref": "#/components/schemas/organization-role" + examples: + default: + "$ref": "#/components/examples/organization-role-list" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + post: + summary: Create a custom organization role + description: |- + Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + + For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/create-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the custom role. + description: + type: string + description: A short description about the intended usage of this + role or what permissions it grants. + permissions: + type: array + description: A list of additional permissions included in this role. + items: + type: string + required: + - name + - permissions + examples: + default: + value: + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + examples: + default: + value: + id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + 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 + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:19:11Z' + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/teams/{team_slug}": + delete: + summary: Remove all organization roles for a team + description: |- + Removes all assigned organization roles from a team. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members:write` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/revoke-all-org-roles-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": + put: + summary: Assign an organization role to a team + description: |- + Assigns an organization role to a team in an organization. + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members` organization read-write permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/assign-team-to-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + '404': + description: Response if the organization, team or role does not exist. + '422': + description: Response if the organization roles feature is not enabled for + the organization, or validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + delete: + summary: Remove an organization role from a team + description: |- + Removes an organization role from a team. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members:write` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/revoke-org-role-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/users/{username}": + delete: + summary: Remove all organization roles for a user + description: |- + Revokes all assigned organization roles from a user. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members:write` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/revoke-all-org-roles-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/users/{username}/{role_id}": + put: + summary: Assign an organization role to a user + description: |- + Assigns an organization role to a member of an organization. + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members` organization read-write permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/assign-user-to-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + '404': + description: Response if the organization, user or role does not exist. + '422': + 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. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + delete: + summary: Remove an organization role from a user + description: |- + Remove an organization role from a user. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members:write` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/revoke-org-role-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/{role_id}": + get: + summary: Get an organization role + description: |- + Gets an organization role that is available to this organization. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/get-org-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + examples: + default: + "$ref": "#/components/examples/organization-role" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + patch: + summary: Update a custom organization role + description: |- + Updates an existing custom organization role. Permission changes will apply to all assignees. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + + For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/patch-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the custom role. + description: + type: string + description: A short description about the intended usage of this + role or what permissions it grants. + permissions: + type: array + description: A list of additional permissions included in this role. + items: + type: string + examples: + default: + value: + description: Permissions to manage custom roles within an org. + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + examples: + default: + value: + id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + 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 + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:19:11Z' + '422': + "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + delete: + summary: Delete a custom organization role. + description: |- + Deletes a custom organization role. + + To use this endpoint, the authenticated user must be one of: + + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + + The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. + GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. + + For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/delete-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/{role_id}/teams": + get: + summary: List teams that are assigned to an organization role + description: |- + Lists the teams that are assigned to an organization role. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members` organization read permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/list-org-role-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#list-teams-that-are-assigned-to-an-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response - List of assigned teams + content: + application/json: + schema: + type: array + description: List of teams assigned to the organization role + items: + "$ref": "#/components/schemas/team" + examples: + default: + "$ref": "#/components/examples/team-items" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + description: Response if the organization or role does not exist. + '422': + description: Response if the organization roles feature is not enabled or + validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/orgs/{org}/organization-roles/{role_id}/users": + get: + summary: List users that are assigned to an organization role + description: |- + Lists organization members that are assigned to an organization role. + + To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + GitHub Apps must have the `members` organization read permission to use this endpoint. + + For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + tags: + - orgs + operationId: orgs/list-org-role-users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/organization-roles#list-users-that-are-assigned-to-an-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response - List of assigned users + content: + application/json: + schema: + type: array + description: List of users assigned to the organization role + items: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user-items" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + description: Response if the organization or role does not exist. + '422': + description: Response if the organization roles feature is not enabled or + validation failed. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles "/orgs/{org}/outside_collaborators": get: summary: List outside collaborators for an organization @@ -10109,6 +10744,355 @@ paths: enabledForGitHubApps: true category: projects subcategory: projects + "/orgs/{org}/properties/schema": + get: + summary: Get all custom properties for an organization + description: |- + Gets all custom properties defined for an organization. + You must be an organization owner to use this endpoint. + tags: + - orgs + operationId: orgs/get-all-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-custom-property" + examples: + default: + "$ref": "#/components/examples/org-custom-properties" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + patch: + summary: Create or update custom properties for an organization + description: |- + Creates new or updates existing custom properties defined for an organization in a batch. + Only organization owners (or users with the proper permissions granted by them) can update these properties + tags: + - orgs + operationId: orgs/create-or-update-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: The array of custom properties to create or update. + items: + "$ref": "#/components/schemas/org-custom-property" + minItems: 1 + maxItems: 100 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + - property_name: service + value_type: string + - property_name: team + value_type: string + description: Team owning the repository + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-custom-property" + examples: + default: + "$ref": "#/components/examples/org-custom-properties" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + "/orgs/{org}/properties/schema/{custom_property_name}": + get: + summary: Get a custom property for an organization + description: |- + Gets a custom property that is defined for an organization. + You must be an organization owner to use this endpoint. + tags: + - orgs + operationId: orgs/get-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/custom-property-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-custom-property" + examples: + default: + "$ref": "#/components/examples/org-custom-property" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + put: + summary: 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. + You must be an organization owner to use this endpoint. + tags: + - orgs + operationId: orgs/create-or-update-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/custom-property-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + value_type: + type: string + example: single_select + enum: + - string + - single_select + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + nullable: true + description: Ordered list of allowed values of the property + required: + - value_type + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-custom-property" + examples: + default: + "$ref": "#/components/examples/org-custom-property" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + delete: + summary: Remove a custom property for an organization + description: |- + Removes a custom property that is defined for an organization. + You must be an organization owner to use this endpoint. + tags: + - orgs + operationId: orgs/remove-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/custom-property-name" + responses: + '204': + "$ref": "#/components/responses/no_content" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + "/orgs/{org}/properties/values": + get: + summary: List custom property values for organization repositories + description: |- + Lists organization repositories with all of their custom property values. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/list-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: repository_query + 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. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-repo-custom-property-values" + examples: + default: + "$ref": "#/components/examples/org-repo-custom-property-values" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties + patch: + summary: 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. + Each target repository will have its custom property values updated to match the values provided in the request. + + A maximum of 30 repositories can be updated in a single request. + + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Only organization owners (or users with the proper permissions granted by them) can update these properties + tags: + - orgs + operationId: orgs/create-or-update-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_names: + type: array + description: The names of repositories that the custom property + values will be applied to. + items: + type: string + minItems: 1 + maxItems: 30 + properties: + type: array + description: List of custom property names and associated values + to apply to the repositories. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - repository_names + - properties + examples: + default: + "$ref": "#/components/examples/org-repo-update-custom-property-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: custom-properties "/orgs/{org}/public_members": get: summary: List public organization members @@ -10458,6 +11442,12 @@ paths: - `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. + custom_properties: + type: object + description: The custom properties for the new repository. The keys + are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true required: - name examples: @@ -10883,6 +11873,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" responses: '200': description: Response @@ -11510,7 +12501,7 @@ paths: description: |- Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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`. tags: @@ -11715,7 +12706,7 @@ paths: description: |- Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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`. tags: @@ -12594,6 +13585,8 @@ paths: If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: - teams @@ -12778,8 +13771,7 @@ paths: - extended examples: default: - value: - query_suite: default + value: responses: '204': description: Action started @@ -20369,9 +21361,6 @@ paths: To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - GitHub Apps must have the `security_events` read - permission to use this endpoint. - The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert for the default branch (or for the specified Git reference if you used `ref` in the request). @@ -20445,8 +21434,7 @@ paths: description: Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on - public repos only. GitHub Apps must have the `security_events` read permission - to use this endpoint. + public repos only. tags: - code-scanning operationId: code-scanning/get-alert @@ -20485,8 +21473,7 @@ paths: description: Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope - for public repositories only. GitHub Apps must have the `security_events` - write permission to use this endpoint. + for public repositories only. operationId: code-scanning/update-alert tags: - code-scanning @@ -20547,7 +21534,6 @@ paths: Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. - GitHub Apps must have the `security_events` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/list-alert-instances @@ -20601,7 +21587,6 @@ paths: You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. - GitHub Apps must have the `security_events` read permission to use this endpoint. **Deprecation notice**: The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. @@ -20672,7 +21657,6 @@ paths: Gets a specified code scanning analysis for a repository. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. - GitHub Apps must have the `security_events` read permission to use this endpoint. The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, @@ -20858,7 +21842,6 @@ paths: For private repositories, you must use an access token with the `security_events` scope. For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - GitHub Apps must have the `contents` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/list-codeql-databases @@ -20906,7 +21889,6 @@ paths: For private repositories, you must use an access token with the `security_events` scope. For public repositories, you can use tokens with the `security_events` or `public_repo` scope. - GitHub Apps must have the `contents` read permission to use this endpoint. tags: - code-scanning operationId: code-scanning/get-codeql-database @@ -20952,7 +21934,7 @@ paths: description: |- Gets a code scanning default setup configuration. You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + scope for public repos. tags: - code-scanning operationId: code-scanning/get-default-setup @@ -20988,7 +21970,7 @@ paths: description: |- Updates a code scanning default setup configuration. You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - scope for public repos. GitHub Apps must have the `repo` write permission to use this endpoint. + scope for public repos. tags: - code-scanning operationId: code-scanning/update-default-setup @@ -21101,7 +22083,7 @@ paths: commit_sha: "$ref": "#/components/schemas/code-scanning-analysis-commit-sha" ref: - "$ref": "#/components/schemas/code-scanning-ref" + "$ref": "#/components/schemas/code-scanning-ref-full" sarif: "$ref": "#/components/schemas/code-scanning-analysis-sarif-file" checkout_uri: @@ -21129,6 +22111,7 @@ paths: 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. type: boolean + additionalProperties: false required: - commit_sha - ref @@ -21173,8 +22156,7 @@ paths: for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission - to read security events on public repos only. GitHub Apps must have the `security_events` - read permission to use this endpoint. + to read security events on public repos only. operationId: code-scanning/get-sarif tags: - code-scanning @@ -21689,10 +22671,10 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets": get: summary: List repository secrets - description: Lists all secrets available in a repository without revealing their - encrypted values. You must authenticate using an access token with the `repo` - scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - repository permission to use this endpoint. + description: Lists all development environment secrets available in a repository + without revealing their encrypted values. You must authenticate using an access + token with the `repo` scope to use this endpoint. GitHub Apps must have write + access to the `codespaces_secrets` repository permission to use this endpoint. tags: - codespaces operationId: codespaces/list-repo-secrets @@ -21768,10 +22750,10 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": get: summary: Get a repository secret - description: Gets a single repository secret without revealing its encrypted - value. You must authenticate using an access token with the `repo` scope to - use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - repository permission to use this endpoint. + description: Gets a single repository development environment secret without + revealing its encrypted value. You must authenticate using an access token + with the `repo` scope to use this endpoint. GitHub Apps must have write access + to the `codespaces_secrets` repository permission to use this endpoint. tags: - codespaces operationId: codespaces/get-repo-secret @@ -21800,7 +22782,7 @@ paths: put: summary: Create or update a repository secret description: |- - Creates or updates a repository secret with an encrypted value. Encrypt your secret using + 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)." You must authenticate using an access @@ -21857,10 +22839,10 @@ paths: subcategory: repository-secrets delete: summary: Delete a repository secret - description: Deletes a secret in a repository using the secret name. You must - authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have write access to the `codespaces_secrets` repository - permission to use this endpoint. + description: Deletes a development environment secret in a repository using + the secret name. You must authenticate using an access token with the `repo` + scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` + repository permission to use this endpoint. tags: - codespaces operationId: codespaces/delete-repo-secret @@ -21986,7 +22968,7 @@ 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." @@ -22615,7 +23597,7 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - repos operationId: repos/create-commit-comment @@ -24818,7 +25800,7 @@ paths: post: summary: Create a deployment branch policy description: |- - Creates a deployment branch policy for an environment. + Creates a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. tags: @@ -24846,6 +25828,12 @@ paths: summary: Example of a single branch name pattern value: name: main + type: branch + example-single-tag: + summary: Example of a single tag name pattern + value: + name: v1 + type: tag responses: '200': description: Response @@ -24858,6 +25846,8 @@ paths: "$ref": "#/components/examples/deployment-branch-policy-wildcard" example-single-branch: "$ref": "#/components/examples/deployment-branch-policy-single-branch" + example-single-tag: + "$ref": "#/components/examples/deployment-branch-policy-single-tag" '404': description: Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false @@ -24872,7 +25862,7 @@ paths: get: summary: Get a deployment branch policy description: |- - Gets a deployment branch policy for an environment. + Gets a deployment branch or tag policy for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. tags: @@ -24904,7 +25894,7 @@ paths: put: summary: Update a deployment branch policy description: |- - Updates a deployment branch policy for an environment. + Updates a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. tags: @@ -24946,7 +25936,7 @@ paths: delete: summary: Delete a deployment branch policy description: |- - Deletes a deployment branch policy for an environment. + Deletes a deployment branch or tag policy for an environment. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. tags: @@ -26257,7 +27247,7 @@ paths: operationId: repos/list-webhooks externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#list-repository-webhooks + url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26283,8 +27273,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks post: summary: Create a repository webhook description: |- @@ -26295,7 +27285,7 @@ paths: operationId: repos/create-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#create-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26379,8 +27369,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}": get: summary: Get a repository webhook @@ -26391,7 +27381,7 @@ paths: operationId: repos/get-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#get-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26411,8 +27401,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks patch: summary: Update a repository webhook description: Updates a webhook configured in a repository. If you previously @@ -26424,7 +27414,7 @@ paths: operationId: repos/update-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#update-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26504,8 +27494,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks delete: summary: Delete a repository webhook description: '' @@ -26514,7 +27504,7 @@ paths: operationId: repos/delete-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#delete-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26527,8 +27517,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for a repository @@ -26541,7 +27531,7 @@ paths: operationId: repos/get-webhook-config-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository + url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26559,8 +27549,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-config + category: repos + subcategory: webhooks patch: summary: Update a webhook configuration for a repository description: |- @@ -26572,7 +27562,7 @@ paths: operationId: repos/update-webhook-config-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository + url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26612,8 +27602,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-config + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": get: summary: List deliveries for a repository webhook @@ -26624,7 +27614,7 @@ paths: operationId: repos/list-webhook-deliveries externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26655,8 +27645,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-deliveries + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a delivery for a repository webhook @@ -26666,7 +27656,7 @@ paths: operationId: repos/get-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26689,8 +27679,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-deliveries + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for a repository webhook @@ -26700,7 +27690,7 @@ paths: operationId: repos/redeliver-webhook-delivery externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26716,8 +27706,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repo-deliveries + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/pings": post: summary: Ping a repository webhook @@ -26728,7 +27718,7 @@ paths: operationId: repos/ping-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#ping-a-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26741,8 +27731,8 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/hooks/{hook_id}/tests": post: summary: Test the push repository webhook @@ -26755,7 +27745,7 @@ paths: operationId: repos/test-push-webhook externalDocs: description: API method documentation - url: https://docs.github.com/rest/webhooks/repos#test-the-push-repository-webhook + url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -26768,17 +27758,15 @@ paths: x-github: githubCloudOnly: false enabledForGitHubApps: true - category: webhooks - subcategory: repos + category: repos + subcategory: webhooks "/repos/{owner}/{repo}/import": get: summary: Get an import status description: |- View the progress of an import. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). **Import status** @@ -26840,11 +27828,17 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true put: summary: Start an import - description: |- - Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + description: | + Start a source import to a GitHub repository using GitHub Importer. + Importing into a GitHub repository with GitHub Actions enabled is not supported and will + return a status `422 Unprocessable Entity` response. + + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/start-import @@ -26922,6 +27916,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true patch: summary: Update an import description: |- @@ -26932,9 +27929,7 @@ paths: have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/update-import @@ -27008,14 +28003,15 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true delete: summary: Cancel an import description: | Stop an import for a repository. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/cancel-import @@ -27035,6 +28031,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/import/authors": get: summary: Get commit authors @@ -27043,9 +28042,7 @@ paths: This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-commit-authors @@ -27077,6 +28074,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/import/authors/{author_id}": patch: summary: Map a commit author @@ -27084,9 +28084,7 @@ paths: Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository. - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/map-commit-author @@ -27141,15 +28139,16 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/import/large_files": get: summary: Get large files description: | List files larger than 100MB found during the import - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/get-large-files @@ -27178,6 +28177,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/import/lfs": patch: summary: Update Git LFS preference @@ -27188,9 +28190,7 @@ paths: You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/repositories/working-with-files/managing-large-files). - **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). tags: - migrations operationId: migrations/set-lfs-preference @@ -27240,6 +28240,9 @@ paths: enabledForGitHubApps: true category: migrations subcategory: source-imports + deprecationDate: '2023-10-12' + removalDate: '2024-04-12' + deprecated: true "/repos/{owner}/{repo}/installation": get: summary: Get a repository installation for the authenticated app @@ -27595,7 +28598,8 @@ paths: description: |- Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - issues operationId: issues/create @@ -28447,9 +29451,8 @@ 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. - See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" - and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" - for details. + For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/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)." tags: - issues operationId: issues/create-comment @@ -29538,6 +30541,8 @@ paths: examples: default: "$ref": "#/components/examples/license-content" + '404': + "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30717,6 +31722,42 @@ paths: enabledForGitHubApps: true category: projects subcategory: projects + "/repos/{owner}/{repo}/properties/values": + get: + summary: 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. + tags: + - repos + operationId: repos/get-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-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/custom-property-value" + examples: + default: + "$ref": "#/components/examples/custom-property-values" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests @@ -30817,7 +31858,7 @@ paths: To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/create @@ -31499,7 +32540,8 @@ paths: **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - This endpoint 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/create-review-comment @@ -31635,7 +32677,8 @@ paths: description: |- Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/create-reply-for-review-comment @@ -31798,7 +32841,7 @@ paths: summary: 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/merge @@ -31931,7 +32974,7 @@ paths: summary: 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - pulls operationId: pulls/request-reviewers @@ -32091,7 +33134,7 @@ paths: post: summary: Create a review for a pull request 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." @@ -32679,7 +33722,7 @@ paths: 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - repos operationId: repos/create-release @@ -33875,6 +34918,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/secret-scanning-pagination-before-org-repo" - "$ref": "#/components/parameters/secret-scanning-pagination-after-org-repo" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" responses: '200': description: Response @@ -34346,15 +35390,14 @@ paths: severity: critical state: published add_credit: - summary: When adding a credit to an advisory, you must send the whole - array of values. + summary: To add a credit to an advisory, send the whole array of values. value: credits: - login: monauser type: remediation_developer update_vvrs: - summary: When adding vulnerable versions, you must include existing - vulnerable versions in the array. + summary: To add vulnerable versions, include existing versions in + the array. value: - package: ecosystem: pip @@ -34371,8 +35414,8 @@ paths: vulnerable_functions: - function2 invalid_state_transition: - summary: Some state transitions are invalid, such as changing the - state from `published` to `draft` + summary: Example of an invalid state transition, from `published` + to `draft`. value: state: draft update_severity_with_cvss_set: @@ -36075,7 +37118,7 @@ paths: get: summary: Search code description: |- - Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36179,7 +37222,7 @@ paths: get: summary: Search commits description: |- - Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36252,7 +37295,7 @@ paths: get: summary: Search issues and pull requests description: |- - Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36347,7 +37390,7 @@ paths: get: summary: Search labels description: |- - Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36430,7 +37473,7 @@ paths: get: summary: Search repositories description: |- - Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36511,7 +37554,7 @@ paths: get: summary: Search topics description: |- - Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. + Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36572,7 +37615,7 @@ paths: get: summary: Search users description: |- - Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination). + Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). @@ -36869,7 +37912,7 @@ paths: Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - teams operationId: teams/create-discussion-legacy @@ -37084,7 +38127,7 @@ paths: Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. + 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/overview/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)." tags: - teams operationId: teams/create-discussion-comment-legacy @@ -38672,7 +39715,7 @@ paths: get: summary: List secrets for the authenticated user description: |- - Lists all secrets available for a user's Codespaces without revealing their + Lists all development environment secrets available for a user's codespaces without revealing their encrypted values. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -38749,7 +39792,7 @@ paths: get: summary: Get a secret for the authenticated user description: |- - Gets a secret available to a user's codespaces without revealing its encrypted value. + Gets a development environment secret available to a user's codespaces without revealing its encrypted value. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -38780,7 +39823,7 @@ paths: put: summary: Create or update a secret for the authenticated user description: |- - Creates or updates a secret for a user's codespace with an encrypted value. Encrypt your secret using + Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. @@ -38857,7 +39900,7 @@ paths: delete: summary: Delete a secret for the authenticated user description: |- - Deletes a 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. + 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. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -38882,7 +39925,7 @@ paths: get: summary: List selected repositories for a user secret description: |- - List the repositories that have been granted the ability to use a user's codespace secret. + List the repositories that have been granted the ability to use a user's development environment secret. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -38931,7 +39974,7 @@ paths: put: summary: Set selected repositories for a user secret description: |- - Select the repositories that will use a user's codespace secret. + Select the repositories that will use a user's development environment secret. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. @@ -38989,7 +40032,7 @@ paths: put: summary: Add a selected repository to a user secret description: |- - Adds a repository to the selected repositories for a user's codespace secret. + Adds a repository to the selected repositories for a user's development environment secret. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. tags: @@ -39024,7 +40067,7 @@ paths: delete: summary: Remove a selected repository from a user secret description: |- - Removes a repository from the selected repositories for a user's codespace secret. + Removes a repository from the selected repositories for a user's development environment secret. You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. tags: @@ -45310,18 +46353,18 @@ x-webhooks: - repository - organization - app - delete: + custom-property-created: 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 a custom property. - 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, see "[Custom properties](https://docs.github.com/rest/orgs/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: A new custom property was created. + operationId: custom-property/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -45363,7 +46406,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-custom-property-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45371,25 +46414,87 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: delete + subcategory: custom_property supported-webhook-types: - - repository - organization - app - dependabot-alert-auto-dismissed: + custom-property-deleted: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. + This event occurs when there is activity relating to a custom property. - 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. + 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 "Dependabot alerts" repository permission. + 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 deleted. + operationId: custom-property/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property + 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-custom-property-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - organization + - app + custom-property-updated: + post: + summary: |- + This event occurs when there is activity relating to a custom property. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - description: A Dependabot alert was automatically closed. - operationId: dependabot-alert/auto-dismissed + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -45431,7 +46536,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45439,25 +46544,88 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: custom_property supported-webhook-types: - - repository - organization - app - dependabot-alert-auto-reopened: + custom-property-values-updated: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. + This event occurs when there is activity relating to custom property values for a repository. - 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. + 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. - 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 "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#custom-property-values + 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-custom-property-values-updated" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom-property-values + supported-webhook-types: + - repository + - organization + - app + delete: + 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. - **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - description: A Dependabot alert was automatically reopened. - operationId: dependabot-alert/auto-reopened + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + **Note**: This event will not occur when more than three tags are 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 @@ -45499,7 +46667,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-delete" responses: '200': description: Return a 200 status to indicate that the data was received @@ -45507,12 +46675,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: delete supported-webhook-types: - repository - organization - app - dependabot-alert-created: + dependabot-alert-auto-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -45522,10 +46690,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - 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. + operationId: dependabot-alert/auto-dismissed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -45569,7 +46735,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 @@ -45582,7 +46748,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. @@ -45592,8 +46758,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - description: A Dependabot alert was manually closed. - operationId: dependabot-alert/dismissed + description: A Dependabot alert was automatically reopened. + operationId: dependabot-alert/auto-reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -45637,7 +46803,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 @@ -45650,7 +46816,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. @@ -45660,8 +46826,146 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - 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: + - 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-dependabot-alert-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: dependabot_alert + supported-webhook-types: + - repository + - organization + - app + dependabot-alert-dismissed: + 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. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + + **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + 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: + - 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-dependabot-alert-dismissed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: dependabot_alert + supported-webhook-types: + - repository + - organization + - app + dependabot-alert-fixed: + 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. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + + **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. + 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: @@ -54184,7 +55488,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: The title or body of a pull request was edited. + 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 @@ -57002,7 +58307,7 @@ x-webhooks: 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 "Administration" repository permission. + 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: @@ -57068,7 +58373,7 @@ x-webhooks: 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 "Administration" repository permission. + 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: @@ -57134,7 +58439,7 @@ x-webhooks: 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 "Administration" repository permission. + 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: @@ -60983,6 +62288,14 @@ components: enum: - read - write + organization_custom_properties: + type: string + description: The level of permission to grant the access token for custom + property management. + enum: + - read + - write + - admin organization_announcement_banners: type: string description: The level of permission to grant the access token to view and @@ -62601,10 +63914,7 @@ components: ## Attribution - This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - - [homepage]: http://contributor-covenant.org - [version]: http://contributor-covenant.org/version/1/4/ + 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/). html_url: type: string format: uri @@ -63312,6 +64622,13 @@ components: 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 actor: title: Actor description: Actor @@ -66157,8 +67474,8 @@ components: code-scanning-ref: type: string description: |- - The full Git reference, formatted as `refs/heads/`, - `refs/pull//merge`, or `refs/pull//head`. + The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + `refs/heads/` or simply ``. code-scanning-analysis-analysis-key: type: string description: Identifies the configuration under which the analysis was executed. @@ -66615,8 +67932,8 @@ components: - key_id - key copilot-seat-breakdown: - title: Copilot for Business Seat Breakdown - description: The breakdown of Copilot for Business seats for the organization. + title: Copilot Business Seat Breakdown + description: The breakdown of Copilot Business seats for the organization. type: object properties: total: @@ -66643,9 +67960,9 @@ components: description: The number of seats that have not used Copilot during the current billing cycle. copilot-organization-details: - title: Copilot for Business Organization Details + title: Copilot Business Organization Details description: Information about the seat breakdown and policies set for an organization - with a Copilot for Business subscription. + with a Copilot Business subscription. type: object properties: seat_breakdown: @@ -66941,9 +68258,9 @@ components: - created_at - updated_at copilot-seat-details: - title: Copilot for Business Seat Detail - description: Information about a Copilot for Business seat assignment for a - user, team, or organization. + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment for a user, + team, or organization. type: object properties: assignee: @@ -67719,6 +69036,56 @@ components: - url - created_at - updated_at + organization-fine-grained-permission: + title: Organization Fine-Grained Permission + description: A fine-grained permission that protects organization resources. + type: object + properties: + name: + type: string + description: + type: string + required: + - name + - description + organization-role: + title: Organization Role + description: Organization roles + type: object + properties: + id: + description: The unique identifier of the role. + type: integer + name: + description: The name of the role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: string + nullable: true + permissions: + description: A list of permissions included in this role. + type: array + items: + type: string + organization: + "$ref": "#/components/schemas/nullable-simple-user" + created_at: + description: The date and time the role was created. + type: string + format: date-time + updated_at: + description: The date and time the role was last updated. + type: string + format: date-time + required: + - id + - name + - permissions + - organization + - created_at + - updated_at package-version: title: Package Version description: A version of a software package @@ -68021,6 +69388,80 @@ components: - columns_url - created_at - updated_at + org-custom-property: + title: Organization Custom Property + description: Custom property defined on an organization + type: object + properties: + property_name: + type: string + description: The name of the property + value_type: + type: string + example: single_select + enum: + - string + - single_select + description: The type of the value for the property + required: + type: boolean + description: Whether the property is required. + default_value: + type: string + nullable: true + description: Default value of the property + description: + type: string + nullable: true + description: Short description of the property + allowed_values: + type: array + items: + type: string + nullable: true + description: Ordered list of allowed values of the property + required: + - property_name + - value_type + custom-property-value: + title: Custom Property Value + description: Custom property name and associated value + type: object + properties: + property_name: + type: string + description: The name of the property + value: + type: string + description: The value assigned to the property + nullable: true + required: + - property_name + - value + org-repo-custom-property-values: + title: Organization Repository Custom Property Values + description: List of custom property values for a repository + type: object + properties: + repository_id: + type: integer + example: 1296269 + repository_name: + type: string + example: Hello-World + repository_full_name: + type: string + example: octocat/Hello-World + properties: + type: array + items: + "$ref": "#/components/schemas/custom-property-value" + description: List of custom property names and associated values + required: + - repository_id + - repository_name + - repository_full_name + - properties repository-rule-enforcement: type: string description: The enforcement level of the ruleset. `evaluate` allows admins @@ -68041,7 +69482,8 @@ components: properties: actor_id: type: integer - description: The ID of the actor that can bypass a ruleset + description: The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. actor_type: type: string enum: @@ -68196,7 +69638,7 @@ components: repository-rule-required-deployments: title: required_deployments description: Choose which environments must be successfully deployed to before - refs can be merged into a branch that matches this rule. + refs can be pushed into a ref that matches this rule. type: object required: - type @@ -68286,10 +69728,9 @@ components: - context repository-rule-required-status-checks: title: required_status_checks - description: Choose which status checks must pass before branches can be merged - into a branch that matches this rule. When enabled, commits must first be - pushed to another branch, then merged or pushed directly to a ref that matches - this rule after status checks have passed. + 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. type: object required: - type @@ -68495,6 +69936,48 @@ components: required: - operator - pattern + repository-rule-params-workflow-file-reference: + title: WorkflowFileReference + description: A workflow that must run for this rule to pass + type: object + properties: + path: + type: string + description: The path to the workflow file + ref: + type: string + description: The ref (branch or tag) of the workflow file to use + repository_id: + type: integer + description: The ID of the repository where the workflow is defined + sha: + type: string + description: The commit SHA of the workflow file to use + required: + - path + - repository_id + repository-rule-workflows: + title: workflows + description: Require all changes made to a targeted branch to pass the specified + workflows before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - workflows + parameters: + type: object + properties: + workflows: + type: array + description: Workflows that must pass for this rule to pass. + items: + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + required: + - workflows repository-rule: title: Repository Rule type: object @@ -68514,6 +69997,7 @@ 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" + - "$ref": "#/components/schemas/repository-rule-workflows" repository-ruleset: title: Repository ruleset type: object @@ -68804,7 +70288,9 @@ components: nullable: true url: type: string + format: uri description: The API URL for the advisory. + readOnly: true html_url: type: string format: uri @@ -69547,7 +71033,7 @@ components: type: boolean private: description: Whether or not this discussion should be restricted to team - members and organization administrators. + members and organization owners. example: true type: boolean team_url: @@ -69783,9 +71269,9 @@ components: - created_at - updated_at - permissions - nullable-repository: - title: Repository - description: A repository on GitHub. + team-repository: + title: Team Repository + description: A team's access to a repository. type: object properties: id: @@ -69804,8 +71290,6 @@ components: example: octocat/Hello-World license: "$ref": "#/components/schemas/nullable-license-simple" - organization: - "$ref": "#/components/schemas/nullable-simple-user" forks: type: integer permissions: @@ -69825,8 +71309,11 @@ components: - admin - pull - push + role_name: + type: string + example: admin owner: - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" private: description: Whether the repository is private or public. default: false @@ -70002,8 +71489,6 @@ components: type: integer example: 80 size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. type: integer example: 108 default_branch: @@ -70045,12 +71530,6 @@ components: default: true type: boolean example: true - deprecated: true - has_discussions: - description: Whether discussions are enabled. - default: false - type: boolean - example: true archived: description: Whether the repository is archived. default: false @@ -70082,270 +71561,6 @@ components: default: true type: boolean example: true - template_repository: - nullable: true - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - owner: - type: object - properties: - login: - type: string - id: - type: integer - node_id: - type: string - avatar_url: - type: string - gravatar_id: - type: string - url: - type: string - html_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - subscriptions_url: - type: string - organizations_url: - type: string - repos_url: - type: string - events_url: - type: string - received_events_url: - type: string - type: - type: string - site_admin: - type: boolean - private: - type: boolean - html_url: - type: string - description: - type: string - fork: - type: boolean - url: - type: string - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - downloads_url: - type: string - events_url: - type: string - forks_url: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - pulls_url: - type: string - releases_url: - type: string - ssh_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - clone_url: - type: string - mirror_url: - type: string - hooks_url: - type: string - svn_url: - type: string - homepage: - type: string - language: - type: string - forks_count: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - size: - type: integer - default_branch: - type: string - open_issues_count: - type: integer - is_template: - type: boolean - topics: - type: array - items: - type: string - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_downloads: - type: boolean - archived: - type: boolean - disabled: - type: boolean - visibility: - type: string - pushed_at: - type: string - created_at: - type: string - updated_at: - type: string - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - allow_rebase_merge: - type: boolean - temp_clone_token: - type: string - allow_squash_merge: - type: boolean - allow_auto_merge: - type: boolean - delete_branch_on_merge: - type: boolean - allow_update_branch: - type: boolean - use_squash_pr_title_as_default: - type: boolean - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - 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). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - 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. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - 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). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - 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. - allow_merge_commit: - type: boolean - subscribers_count: - type: integer - network_count: - type: integer temp_clone_token: type: string allow_squash_merge: @@ -70363,64 +71578,6 @@ components: default: false type: boolean example: false - allow_update_branch: - 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 - type: boolean - example: false - use_squash_pr_title_as_default: - type: boolean - description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` - instead. - default: false - deprecated: true - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - 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). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - 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. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - 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). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - 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. allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true @@ -70428,11 +71585,14 @@ components: example: true allow_forking: description: Whether to allow forking this repo + default: false type: boolean + example: false web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean + example: false subscribers_count: type: integer network_count: @@ -70443,12 +71603,6 @@ components: type: integer master_branch: type: string - starred_at: - type: string - example: '"2020-07-09T00:17:42Z"' - anonymous_access_enabled: - type: boolean - description: Whether anonymous git access is enabled for this repository required: - archive_url - assignees_url @@ -70523,10 +71677,179 @@ components: - watchers_count - created_at - updated_at - nullable: true - team-repository: - title: Team Repository - description: A team's access to a repository. + 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 + 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 + properties: + limit: + type: integer + remaining: + type: integer + reset: + type: integer + used: + type: integer + required: + - limit + - remaining + - reset + - used + rate-limit-overview: + title: Rate Limit Overview + description: Rate Limit Overview + type: object + properties: + resources: + type: object + properties: + core: + "$ref": "#/components/schemas/rate-limit" + graphql: + "$ref": "#/components/schemas/rate-limit" + search: + "$ref": "#/components/schemas/rate-limit" + code_search: + "$ref": "#/components/schemas/rate-limit" + source_import: + "$ref": "#/components/schemas/rate-limit" + integration_manifest: + "$ref": "#/components/schemas/rate-limit" + code_scanning_upload: + "$ref": "#/components/schemas/rate-limit" + actions_runner_registration: + "$ref": "#/components/schemas/rate-limit" + scim: + "$ref": "#/components/schemas/rate-limit" + dependency_snapshots: + "$ref": "#/components/schemas/rate-limit" + required: + - core + - search + rate: + "$ref": "#/components/schemas/rate-limit" + required: + - rate + - resources + nullable-repository: + title: Repository + description: A repository on GitHub. type: object properties: id: @@ -70545,6 +71868,8 @@ components: example: octocat/Hello-World license: "$ref": "#/components/schemas/nullable-license-simple" + organization: + "$ref": "#/components/schemas/nullable-simple-user" forks: type: integer permissions: @@ -70564,11 +71889,8 @@ components: - admin - pull - push - role_name: - type: string - example: admin owner: - "$ref": "#/components/schemas/nullable-simple-user" + "$ref": "#/components/schemas/simple-user" private: description: Whether the repository is private or public. default: false @@ -70744,6 +72066,8 @@ components: type: integer example: 80 size: + description: The size of the repository. Size is calculated hourly. When + a repository is initially created, the size is 0. type: integer example: 108 default_branch: @@ -70785,6 +72109,12 @@ components: default: true type: boolean example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true archived: description: Whether the repository is archived. default: false @@ -70817,7 +72147,269 @@ components: type: boolean example: true template_repository: - "$ref": "#/components/schemas/nullable-repository" + nullable: true + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + owner: + type: object + properties: + login: + type: string + id: + type: integer + node_id: + type: string + avatar_url: + type: string + gravatar_id: + type: string + url: + type: string + html_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + starred_url: + type: string + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + private: + type: boolean + html_url: + type: string + description: + type: string + fork: + type: boolean + url: + type: string + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + downloads_url: + type: string + events_url: + type: string + forks_url: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + pulls_url: + type: string + releases_url: + type: string + ssh_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + clone_url: + type: string + mirror_url: + type: string + hooks_url: + type: string + svn_url: + type: string + homepage: + type: string + language: + type: string + forks_count: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + size: + type: integer + default_branch: + type: string + open_issues_count: + type: integer + is_template: + type: boolean + topics: + type: array + items: + type: string + has_issues: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + created_at: + type: string + updated_at: + type: string + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + allow_rebase_merge: + type: boolean + temp_clone_token: + type: string + allow_squash_merge: + type: boolean + allow_auto_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_update_branch: + type: boolean + use_squash_pr_title_as_default: + type: boolean + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + 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). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + 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. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + 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). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + 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. + allow_merge_commit: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer temp_clone_token: type: string allow_squash_merge: @@ -70835,6 +72427,64 @@ components: default: false type: boolean example: false + allow_update_branch: + 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 + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title + as default. **This property has been deprecated. Please use `squash_merge_commit_title` + instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + 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). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + 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. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + 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). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + 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. allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true @@ -70842,14 +72492,11 @@ components: example: true allow_forking: description: Whether to allow forking this repo - default: false type: boolean - example: false web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean - example: false subscribers_count: type: integer network_count: @@ -70860,6 +72507,12 @@ components: type: integer master_branch: type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository required: - archive_url - assignees_url @@ -70934,176 +72587,7 @@ 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 - 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 - properties: - limit: - type: integer - remaining: - type: integer - reset: - type: integer - used: - type: integer - required: - - limit - - remaining - - reset - - used - rate-limit-overview: - title: Rate Limit Overview - description: Rate Limit Overview - type: object - properties: - resources: - type: object - properties: - core: - "$ref": "#/components/schemas/rate-limit" - graphql: - "$ref": "#/components/schemas/rate-limit" - search: - "$ref": "#/components/schemas/rate-limit" - code_search: - "$ref": "#/components/schemas/rate-limit" - source_import: - "$ref": "#/components/schemas/rate-limit" - integration_manifest: - "$ref": "#/components/schemas/rate-limit" - code_scanning_upload: - "$ref": "#/components/schemas/rate-limit" - actions_runner_registration: - "$ref": "#/components/schemas/rate-limit" - scim: - "$ref": "#/components/schemas/rate-limit" - dependency_snapshots: - "$ref": "#/components/schemas/rate-limit" - required: - - core - - search - rate: - "$ref": "#/components/schemas/rate-limit" - required: - - rate - - resources + nullable: true code-of-conduct-simple: title: Code Of Conduct Simple description: Code of Conduct Simple @@ -71738,6 +73222,7 @@ components: - queued - in_progress - completed + - waiting conclusion: description: The outcome of the job. example: success @@ -74364,8 +75849,8 @@ components: header must be set to the value of the `content_type` property. commit_oid: type: string - description: The commit SHA of the CodeQL databases repository at time of - database creation. + description: The commit SHA of the repository at the time the CodeQL database + was created. nullable: true required: - id @@ -74426,8 +75911,7 @@ components: type: object properties: state: - description: Whether code scanning default setup has been configured or - not. + description: The desired state of code scanning default setup. type: string enum: - configured @@ -74452,8 +75936,7 @@ components: - python - ruby - swift - required: - - state + additionalProperties: false code-scanning-default-setup-update-response: description: |- You can use `run_url` to track the status of the run. This includes a property status and conclusion. @@ -74466,6 +75949,13 @@ components: run_url: description: URL of the corresponding run. type: string + code-scanning-ref-full: + type: string + description: |- + The full Git reference, formatted as `refs/heads/`, + `refs/pull//merge`, or `refs/pull//head`. + pattern: "^refs/(heads|pull)/.*$" + example: refs/heads/main code-scanning-analysis-sarif-file: 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) @@ -76857,33 +78347,47 @@ components: their own job. deployment-branch-policy: title: Deployment branch policy - description: Details of a deployment branch policy. + description: Details of a deployment branch or tag policy. type: object properties: id: - description: The unique identifier of the branch policy. + description: The unique identifier of the branch or tag policy. type: integer example: 361471 node_id: type: string example: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= name: - description: The name pattern that branches must match in order to deploy - to the environment. + description: The name pattern that branches or tags must match in order + to deploy to the environment. type: string example: release/* + type: + description: Whether this rule targets a branch or tag. + type: string + example: branch + enum: + - branch + - tag deployment-branch-policy-name-pattern-with-type: - title: Deployment branch policy name pattern + title: Deployment branch and tag policy name pattern type: object properties: name: description: |- - The name pattern that branches must match in order to deploy to the environment. + The name pattern that branches or tags must match in order to deploy to the environment. Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. 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). type: string example: release/* + type: + description: Whether this rule targets a branch or tag + type: string + example: branch + enum: + - branch + - tag required: - name deployment-branch-policy-name-pattern: @@ -81501,6 +83005,9 @@ components: - allOf: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" secret-scanning-alert: type: object properties: @@ -81556,6 +83063,13 @@ components: description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown 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`. @@ -84318,6 +85832,12 @@ components: type: array items: type: string + 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 has_issues: description: Whether issues are enabled. default: true @@ -85665,6 +87185,12 @@ components: type: array items: type: string + 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 has_issues: description: Whether issues are enabled. default: true @@ -90582,6 +92108,112 @@ components: - pusher_type - repository - sender + webhook-custom-property-created: + title: custom property created event + type: object + properties: + action: + type: string + enum: + - created + definition: + "$ref": "#/components/schemas/org-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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-deleted: + title: custom property deleted event + type: object + properties: + action: + type: string + enum: + - deleted + definition: + type: object + properties: + property_name: + type: string + description: The name of the property that was deleted. + required: + - property_name + 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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-updated: + title: custom property updated event + type: object + properties: + action: + type: string + enum: + - updated + definition: + "$ref": "#/components/schemas/org-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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-values-updated: + title: Custom property values updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + repository: + "$ref": "#/components/schemas/repository-webhooks" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + new_property_values: + type: array + description: The new custom property values for the repository. + items: + "$ref": "#/components/schemas/custom-property-value" + old_property_values: + type: array + description: The old custom property values for the repository. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - action + - repository + - organization + - new_property_values + - old_property_values webhook-delete: title: delete event type: object @@ -98002,6 +99634,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -112849,6 +114487,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -117063,6 +118707,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -188511,6 +190161,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -196605,6 +198261,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -197186,6 +198848,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -197768,6 +199436,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -198414,6 +200088,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -198997,6 +200677,12 @@ components: - type: integer - type: string format: date-time + 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 default_branch: description: The default branch of the repository. type: string @@ -205125,10 +206811,7 @@ components: ## Attribution - This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] - - [homepage]: http://contributor-covenant.org - [version]: http://contributor-covenant.org/version/1/4/ + 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/). html_url: http://contributor-covenant.org/version/1/4/ emojis-get: value: @@ -207423,6 +209106,7 @@ components: push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment + validity: active - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -207504,6 +209188,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: resolution_comment: + validity: unknown public-events-items: value: - id: '22249084947' @@ -211286,6 +212971,96 @@ components: status: enabled secret_scanning_push_protection: status: disabled + organization-fine-grained-permission-example: + value: + - name: read_organization_custom_org_role + description: View organization roles + - name: write_organization_custom_org_role + description: Manage custom organization roles + organization-role-list: + value: + total_count: 2 + roles: + - id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + 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 + site_admin: false + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + - id: 8031 + name: Auditor + description: Permissions to read the organization audit log + permissions: + - read_audit_logs + organization: + login: github + id: 9919 + node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= + avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 + 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 + site_admin: false + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' + organization-role: + value: + id: 8030 + name: Custom Role Manager + description: Permissions to manage custom roles within an org + permissions: + - write_organization_custom_repo_role + - write_organization_custom_org_role + - read_organization_custom_repo_role + - read_organization_custom_org_role + organization: + 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 + created_at: '2022-07-04T22:19:11Z' + updated_at: '2022-07-04T22:20:11Z' package-org: value: id: 197 @@ -211485,6 +213260,55 @@ components: site_admin: false created_at: '2011-04-11T20:09:31Z' updated_at: '2014-03-04T18:58:10Z' + org-custom-properties: + value: + - property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + - property_name: service + value_type: string + - property_name: team + value_type: string + description: Team owning the repository + org-custom-property: + value: + property_name: environment + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development + org-repo-custom-property-values: + value: + - repository_id: 1296269 + repository_name: Hello-World + repository_full_name: octocat/Hello-World + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + org-repo-update-custom-property-values: + value: + repository_names: + - Hello-World + - octo-repo + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat repository: value: id: 1296269 @@ -211869,6 +213693,7 @@ components: repositories_url: https://api.github.com/teams/1/repos permission: admin parent: + private_fork: - ghsa_id: GHSA-1234-5678-9012 cve_id: CVE-2051-0000 url: https://api.github.com/repos/repo/a-package/security-advisories/GHSA-1234-5678-9012 @@ -211926,7 +213751,7 @@ components: closed_at: withdrawn_at: submission: - - accepted: true + accepted: true vulnerabilities: - package: ecosystem: pip @@ -212008,6 +213833,71 @@ components: repositories_url: https://api.github.com/teams/1/repos permission: admin parent: + private_fork: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo-ghsa-1234-5678-9012 + full_name: octo-org/octo-repo-ghsa-1234-5678-9012 + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo-ghsa-1234-5678-9012 + description: + fork: false + url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012 + archive_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/branches{/branch} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/comments{/number} + commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/commits{/sha} + compare_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/contributors + deployments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/deployments + downloads_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/downloads + events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/events + forks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/forks + git_commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/hooks + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/issues{/number} + keys_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/labels{/name} + languages_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/languages + merges_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/merges + milestones_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/stargazers + statuses_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/subscription + 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 @@ -212592,125 +214482,6 @@ components: pull: true role_name: read allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - 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-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - triage: false - push: false - maintain: false - admin: false - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false @@ -214139,6 +215910,7 @@ components: check_suite_node_id: MDEwOkNoZWNrU3VpdGU0Mg== head_branch: master head_sha: acb5820ced9479c074f688cc328bf03f341a511d + path: ".github/workflows/build.yml@main" run_number: 562 event: push display_title: Update README.md @@ -216731,7 +218503,7 @@ components: created_at: '2022-09-12T12:14:32Z' updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java - commit_oid: 12345678901234567890 + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c - id: 2 name: database.zip language: ruby @@ -216759,7 +218531,7 @@ components: created_at: '2022-09-12T12:14:32Z' updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby - commit_oid: 23456789012345678901 + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c code-scanning-codeql-database: value: id: 1 @@ -216789,7 +218561,7 @@ components: created_at: '2022-09-12T12:14:32Z' updated_at: '2022-09-12T12:14:32Z' url: https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java - commit_oid: 12345678901234567890 + commit_oid: 1927de39fefa25a9d0e64e3f540ff824a72f538c code-scanning-default-setup: value: state: configured @@ -219612,6 +221384,12 @@ components: id: 364663 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= name: main + deployment-branch-policy-single-tag: + value: + id: 364663 + node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM= + name: v1 + type: tag deployment-protection-rules: value: - total_count: 2 @@ -221622,6 +223400,14 @@ components: site_admin: false created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' + custom-property-values: + value: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -223974,6 +225760,7 @@ components: push_protection_bypassed: true push_protection_bypassed_at: '2020-11-06T21:48:51Z' resolution_comment: Example comment + validity: inactive - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -223990,6 +225777,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: resolution_comment: + validity: unknown secret-scanning-alert-open: value: number: 42 @@ -224008,6 +225796,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: resolution_comment: + validity: unknown secret-scanning-alert-resolved: value: number: 42 @@ -224044,6 +225833,7 @@ components: push_protection_bypassed_by: push_protection_bypassed_at: resolution_comment: Example comment + validity: unknown secret-scanning-location-list: value: - type: commit @@ -224206,6 +225996,71 @@ components: repositories_url: https://api.github.com/teams/1/repos permission: admin parent: + private_fork: + id: 217723378 + node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= + name: octo-repo-ghsa-abcd-1234-efgh + full_name: octo-org/octo-repo-ghsa-abcd-1234-efgh + owner: + login: octo-org + id: 6811672 + node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= + avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 + gravatar_id: '' + url: https://api.github.com/users/octo-org + html_url: https://github.com/octo-org + followers_url: https://api.github.com/users/octo-org/followers + following_url: https://api.github.com/users/octo-org/following{/other_user} + gists_url: https://api.github.com/users/octo-org/gists{/gist_id} + starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octo-org/subscriptions + organizations_url: https://api.github.com/users/octo-org/orgs + repos_url: https://api.github.com/users/octo-org/repos + events_url: https://api.github.com/users/octo-org/events{/privacy} + received_events_url: https://api.github.com/users/octo-org/received_events + type: Organization + site_admin: false + private: true + html_url: https://github.com/octo-org/octo-repo-ghsa-abcd-1234-efgh + description: + fork: false + url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh + archive_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/assignees{/user} + blobs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/blobs{/sha} + branches_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/branches{/branch} + collaborators_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/comments{/number} + commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/commits{/sha} + compare_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/compare/{base}...{head} + contents_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contents/{+path} + contributors_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/contributors + deployments_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/deployments + downloads_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/downloads + events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/events + forks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/forks + git_commits_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/tags{/sha} + hooks_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/hooks + issue_comment_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues/events{/number} + issues_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/issues{/number} + keys_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/keys{/key_id} + labels_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/labels{/name} + languages_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/languages + merges_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/merges + milestones_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/milestones{/number} + notifications_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/pulls{/number} + releases_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/releases{/id} + stargazers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/stargazers + statuses_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/statuses/{sha} + subscribers_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscribers + subscription_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/subscription + tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/tags + teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/teams + trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-abcd-1234-efgh/git/trees{/sha} repository-advisory-pvr: value: ghsa_id: GHSA-abcd-1234-efgh @@ -224320,6 +226175,7 @@ components: repositories_url: https://api.github.com/teams/1/repos permission: admin parent: + private_fork: simple-user-items-default-response: summary: Default response value: @@ -225776,125 +227632,6 @@ components: pull: true role_name: read allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - 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-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - triage: false - push: false - maintain: false - admin: false - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false @@ -230382,6 +232119,15 @@ components: - 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 + schema: + type: string gist-id: name: gist_id description: The unique identifier of the gist. @@ -230598,6 +232344,20 @@ 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. + in: path + required: true + schema: + type: integer package-visibility: name: visibility description: |- @@ -230709,6 +232469,13 @@ components: required: true schema: type: integer + custom-property-name: + name: custom_property_name + description: The custom property name. The name is case sensitive. + in: path + required: true + schema: + type: string repository-name-in-query: name: repository_name description: The name of the repository to filter on. When specified, only rule @@ -230781,13 +232548,6 @@ components: required: false schema: type: string - team-slug: - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string discussion-number: name: discussion_number description: The number that identifies the discussion. diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index 1ef8a04bd..49920feb8 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -2250,6 +2250,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoices/{invoice}/lines/{line_item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

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

*/ + post: operations["PostInvoicesInvoiceLinesLineItemId"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoices/{invoice}/mark_uncollectible": { parameters: { query?: never; @@ -3338,7 +3358,7 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Returns a list of your prices.

*/ + /** @description

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

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

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

*/ @@ -4418,7 +4438,27 @@ export interface paths { /** @description

Retrieves the subscription with the given ID.

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

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

*/ + /** @description

Updates an existing subscription to match the specified parameters. + * When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. + * To preview how the proration is calculated, use the upcoming invoice endpoint.

+ * + *

By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.

+ * + *

Switching prices does not normally change the billing date or generate an immediate charge unless:

+ * + *
    + *
  • The billing interval is changed (for example, from monthly to yearly).
    • + *
  • The subscription moves from free to paid, or paid to free.
    • + *
  • A trial starts or ends.
    • + *
+ * + *

In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.

+ * + *

If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.

+ * + *

If you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.

+ * + *

Updating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.

*/ post: operations["PostSubscriptionsSubscriptionExposedId"]; /** @description

Cancels a customer’s subscription immediately. The customer will not be charged again for the subscription.

* @@ -4499,6 +4539,43 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/tax/registrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Returns a list of Tax Registration objects.

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

Creates a new Tax Registration object.

*/ + post: operations["PostTaxRegistrations"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/tax/registrations/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Updates an existing Tax Registration object.

+ * + *

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

*/ + post: operations["PostTaxRegistrationsId"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/tax/settings": { parameters: { query?: never; @@ -6070,8 +6147,10 @@ export interface components { }; /** AccountBacsDebitPaymentsSettings */ account_bacs_debit_payments_settings: { - /** @description The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor. */ - display_name?: string; + /** @description The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. */ + display_name?: string | null; + /** @description The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners. */ + service_user_number?: string | null; }; /** AccountBrandingSettings */ account_branding_settings: { @@ -6246,6 +6325,11 @@ export interface components { * @enum {string} */ promptpay_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. + * @enum {string} + */ + revolut_pay_payments?: "active" | "inactive" | "pending"; /** * @description The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. * @enum {string} @@ -6376,7 +6460,7 @@ export interface components { current_deadline?: number | null; /** @description Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ currently_due?: string[] | null; - /** @description This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account. */ + /** @description This is typed as a string for consistency with `requirements.disabled_reason`. */ disabled_reason?: string | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors?: components["schemas"]["account_requirements_error"][] | null; @@ -6452,7 +6536,7 @@ export interface components { current_deadline?: number | null; /** @description Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ currently_due?: string[] | null; - /** @description If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. */ + /** @description If the account is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.incomplete_verification`, `rejected.listed`, `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`. */ disabled_reason?: string | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors?: components["schemas"]["account_requirements_error"][] | null; @@ -6476,7 +6560,7 @@ export interface components { * @description The code for the type of error. * @enum {string} */ - code: "invalid_address_city_state_postal_code" | "invalid_dob_age_under_18" | "invalid_representative_country" | "invalid_street_address" | "invalid_tos_acceptance" | "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_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"; + 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_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"; /** @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. */ @@ -6765,7 +6849,7 @@ export interface components { /** @description Funds held due to negative balances on connected 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"][]; /** @description Funds that you can pay out using Instant Payouts. */ - instant_available?: components["schemas"]["balance_amount"][]; + instant_available?: components["schemas"]["balance_amount_net"][]; issuing?: components["schemas"]["balance_detail"]; /** @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; @@ -6794,6 +6878,14 @@ export interface components { /** @description Amount for FPX. */ fpx?: number; }; + /** BalanceAmountNet */ + balance_amount_net: { + /** @description Balance amount. */ + amount: number; + /** @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ + currency: string; + source_types?: components["schemas"]["balance_amount_by_source_type"]; + }; /** BalanceDetail */ balance_detail: { /** @description Funds that are available for use. */ @@ -6845,10 +6937,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`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. + * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. * @enum {string} */ - type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_inbound" | "obligation_outbound" | "obligation_payout" | "obligation_payout_failure" | "obligation_reversal_inbound" | "obligation_reversal_outbound" | "payment" | "payment_failure_refund" | "payment_refund" | "payment_reversal" | "payout" | "payout_cancel" | "payout_failure" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; + type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_inbound" | "obligation_outbound" | "obligation_payout" | "obligation_payout_failure" | "obligation_reversal_inbound" | "obligation_reversal_outbound" | "payment" | "payment_failure_refund" | "payment_refund" | "payment_reversal" | "payment_unreconciled" | "payout" | "payout_cancel" | "payout_failure" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; }; /** * BankAccount @@ -6902,9 +6994,9 @@ export interface components { requirements?: components["schemas"]["external_account_requirements"] | null; /** @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 transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated. + /** @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 transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. In 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` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In 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; }; /** BankConnectionsResourceAccountholder */ @@ -7210,7 +7302,7 @@ export interface components { * @enum {string} */ object: "card"; - /** @description For external accounts, possible values are `new` and `errored`. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. */ + /** @description For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated. */ status?: string | null; /** @description If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null. */ tokenization_method?: string | null; @@ -7931,11 +8023,34 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutPaypalPaymentMethodOptions */ + checkout_paypal_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + /** @description Preferred locale of the PayPal checkout page that the customer is redirected to. */ + preferred_locale?: string | null; + /** @description A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID. */ + reference?: string | null; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter 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. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** CheckoutPixPaymentMethodOptions */ checkout_pix_payment_method_options: { /** @description The number of seconds after which Pix payment will expire. */ expires_after_seconds?: number | null; }; + /** CheckoutRevolutPayPaymentMethodOptions */ + checkout_revolut_pay_payment_method_options: Record; /** CheckoutSepaDebitPaymentMethodOptions */ checkout_sepa_debit_payment_method_options: { /** @@ -7972,7 +8087,9 @@ export interface components { oxxo?: components["schemas"]["checkout_oxxo_payment_method_options"]; p24?: components["schemas"]["checkout_p24_payment_method_options"]; paynow?: components["schemas"]["checkout_paynow_payment_method_options"]; + paypal?: components["schemas"]["checkout_paypal_payment_method_options"]; pix?: components["schemas"]["checkout_pix_payment_method_options"]; + revolut_pay?: components["schemas"]["checkout_revolut_pay_payment_method_options"]; sepa_debit?: components["schemas"]["checkout_sepa_debit_payment_method_options"]; sofort?: components["schemas"]["checkout_sofort_payment_method_options"]; us_bank_account?: components["schemas"]["checkout_us_bank_account_payment_method_options"]; @@ -8368,9 +8485,11 @@ export interface 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) field instead. */ default_source?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]) | null; - /** @description If Stripe bills the customer's latest invoice by automatically charging and the latest charge fails, it sets `delinquent`` to `true``. If Stripe bills the invoice by sending it, and the invoice isn't paid by the due date, it also sets `delinquent`` to `true`. + /** @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://stripe.com/docs/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`. */ delinquent?: boolean | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -8656,7 +8775,7 @@ export interface 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 learn more about these types. * @enum {string} */ - type: "adjusted_for_overdraft" | "applied_to_payment" | "funded" | "funding_reversed" | "refunded_from_payment" | "return_canceled" | "return_initiated" | "unapplied_from_payment"; + type: "adjusted_for_overdraft" | "applied_to_payment" | "funded" | "funding_reversed" | "refunded_from_payment" | "return_canceled" | "return_initiated" | "transferred_to_balance" | "unapplied_from_payment"; unapplied_from_payment?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"]; }; /** CustomerTax */ @@ -9301,8 +9420,8 @@ export interface components { * `Event` objects directly to an endpoint on your server. You can manage * webhooks in your * [account settings](https://dashboard.stripe.com/account/webhooks). Learn how - * to [listen for events] - * (/docs/webhooks) so that your integration can automatically trigger reactions. + * to [listen for events](https://stripe.com/docs/webhooks) + * so that your integration can automatically trigger reactions. * * When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications * that occur in connected accounts. For these events, there's an @@ -9340,17 +9459,32 @@ export interface components { }; /** * ExchangeRate - * @description `Exchange Rate` 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). + * @description `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. + * + * *[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. + * + * ----- + * + *   * - * If you want a guarantee that the charge is made with a certain exchange rate - * you expect is current, you can pass in `exchange_rate` to charges endpoints. - * If the value is no longer up to date, the charge won't go through. Please - * refer to our [Exchange Rates API](https://stripe.com/docs/exchange-rates) guide for more - * details. + * *This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:* + * + * - *localize prices for processing payments on Stripe* + * - *reconcile Stripe transactions* + * - *determine how much money to send to a connected account* + * - *determine app fees to charge a connected account* + * + * *Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.* */ exchange_rate: { /** @description Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. */ @@ -9451,7 +9585,7 @@ export interface components { /** @description Unique identifier for the object. */ id: string; /** - * FileFileLinkList + * FileResourceFileLinkList * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. */ links?: { @@ -9759,21 +9893,35 @@ export interface components { */ type: "eu_bank_transfer" | "jp_bank_transfer"; }; + /** + * FundingInstructionsBankTransferABARecord + * @description ABA Records contain U.S. bank account details per the ABA format. + */ + funding_instructions_bank_transfer_aba_record: { + /** @description The ABA account number */ + account_number: string; + /** @description The bank name */ + bank_name: string; + /** @description The ABA routing number */ + routing_number: string; + }; /** * FundingInstructionsBankTransferFinancialAddress * @description FinancialAddresses contain identifying information that resolves to a FinancialAccount. */ funding_instructions_bank_transfer_financial_address: { + aba?: components["schemas"]["funding_instructions_bank_transfer_aba_record"]; iban?: components["schemas"]["funding_instructions_bank_transfer_iban_record"]; sort_code?: components["schemas"]["funding_instructions_bank_transfer_sort_code_record"]; spei?: components["schemas"]["funding_instructions_bank_transfer_spei_record"]; /** @description The payment networks supported by this FinancialAddress */ - supported_networks?: ("bacs" | "fps" | "sepa" | "spei" | "zengin")[]; + supported_networks?: ("ach" | "bacs" | "domestic_wire_us" | "fps" | "sepa" | "spei" | "swift" | "zengin")[]; + swift?: components["schemas"]["funding_instructions_bank_transfer_swift_record"]; /** * @description The type of financial address * @enum {string} */ - type: "iban" | "sort_code" | "spei" | "zengin"; + type: "aba" | "iban" | "sort_code" | "spei" | "swift" | "zengin"; zengin?: components["schemas"]["funding_instructions_bank_transfer_zengin_record"]; }; /** @@ -9814,6 +9962,18 @@ export interface components { /** @description The CLABE number */ clabe: string; }; + /** + * FundingInstructionsBankTransferSwiftRecord + * @description SWIFT Records contain U.S. bank account details per the SWIFT format. + */ + funding_instructions_bank_transfer_swift_record: { + /** @description The account number */ + account_number: string; + /** @description The bank name */ + bank_name: string; + /** @description The SWIFT code */ + swift_code: string; + }; /** * FundingInstructionsBankTransferZenginRecord * @description Zengin Records contain Japan bank account details per the Zengin format. @@ -10824,7 +10984,7 @@ export interface components { * Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations) */ "issuing.authorization": { - /** @description The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @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). */ amount_details?: components["schemas"]["issuing_authorization_amount_details"] | null; @@ -10845,15 +11005,15 @@ export interface components { * @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). */ + /** @description The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ currency: 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 The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different. */ merchant_amount: number; - /** @description The currency that was 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). */ + /** @description The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ 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. */ @@ -11102,7 +11262,7 @@ export interface components { }; /** * 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 through Stripe. + * @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. */ "issuing.token": { /** @description Card associated with this token. */ @@ -11190,6 +11350,8 @@ export interface components { metadata: { [key: string]: string | undefined; }; + /** @description Details about the transaction, such as processing dates, set by the card network. */ + network_data?: components["schemas"]["issuing_transaction_network_data"] | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -11219,6 +11381,19 @@ export interface components { /** @description The amount of cash requested by the cardholder. */ cashback_amount?: number | null; }; + /** IssuingAuthorizationAuthenticationExemption */ + issuing_authorization_authentication_exemption: { + /** + * @description The entity that requested the exemption, either the acquiring merchant or the Issuing user. + * @enum {string} + */ + claimed_by: "acquirer" | "issuer"; + /** + * @description The specific exemption claimed for this authorization. + * @enum {string} + */ + type: "low_value_transaction" | "transaction_risk_analysis"; + }; /** 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. */ @@ -11239,11 +11414,17 @@ export interface components { state?: string | null; /** @description An ID assigned by the seller to the location of the sale. */ terminal_id?: string | null; + /** @description URL provided by the merchant on a 3DS request */ + url?: string | null; }; /** IssuingAuthorizationNetworkData */ issuing_authorization_network_data: { /** @description Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`. */ acquiring_institution_id?: string | null; + /** @description The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements. */ + system_trace_audit_number?: string | null; + /** @description Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. */ + transaction_id?: string | null; }; /** IssuingAuthorizationPendingRequest */ issuing_authorization_pending_request: { @@ -11259,6 +11440,8 @@ export interface components { merchant_amount: number; /** @description The local currency the merchant is requesting to authorize. */ merchant_currency: string; + /** @description The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. */ + network_risk_score?: number | null; }; /** IssuingAuthorizationRequest */ issuing_authorization_request: { @@ -11281,13 +11464,28 @@ export interface components { 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; + /** @description The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99. */ + network_risk_score?: number | null; /** * @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_inactive" | "cardholder_inactive" | "cardholder_verification_required" | "insufficient_funds" | "not_allowed" | "spending_controls" | "suspected_fraud" | "verification_failed" | "webhook_approved" | "webhook_declined" | "webhook_error" | "webhook_timeout"; - /** @description If approve/decline decision is directly responsed to the webhook with json payload and if the response is invalid (e.g., parsing errors), we surface the detailed message via this field. */ + /** @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; + /** + * Format: unix-time + * @description Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time. + */ + requested_at?: number | null; + }; + /** IssuingAuthorizationThreeDSecure */ + issuing_authorization_three_d_secure: { + /** + * @description The outcome of the 3D Secure authentication request. + * @enum {string} + */ + result: "attempt_acknowledged" | "authenticated" | "failed" | "required"; }; /** IssuingAuthorizationTreasury */ issuing_authorization_treasury: { @@ -11310,6 +11508,8 @@ export interface components { * @enum {string} */ address_postal_code_check: "match" | "mismatch" | "not_provided"; + /** @description The exemption applied to this authorization. */ + authentication_exemption?: components["schemas"]["issuing_authorization_authentication_exemption"] | null; /** * @description Whether the cardholder provided a CVC and if it matched Stripe’s record. * @enum {string} @@ -11322,6 +11522,8 @@ export interface components { expiry_check: "match" | "mismatch" | "not_provided"; /** @description The postal code submitted as part of the authorization used for postal code verification. */ postal_code?: string | null; + /** @description 3D Secure details. */ + three_d_secure?: components["schemas"]["issuing_authorization_three_d_secure"] | null; }; /** IssuingCardApplePay */ issuing_card_apple_pay: { @@ -11816,6 +12018,15 @@ export interface components { /** @description The number of nights stayed at the lodging. */ nights?: number | null; }; + /** IssuingTransactionNetworkData */ + issuing_transaction_network_data: { + /** @description A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter "S", followed by a six-digit number. For example, "S498162". Please note that the code is not guaranteed to be unique across authorizations. */ + authorization_code?: string | null; + /** @description The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network. */ + processing_date?: string | null; + /** @description Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions. */ + transaction_id?: string | null; + }; /** IssuingTransactionPurchaseDetails */ issuing_transaction_purchase_details: { /** @description Information about the flight that was purchased with this transaction. */ @@ -12839,6 +13050,7 @@ export interface components { paypal?: components["schemas"]["payment_method_options_paypal"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; pix?: components["schemas"]["payment_method_options_pix"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; promptpay?: components["schemas"]["payment_method_options_promptpay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + revolut_pay?: components["schemas"]["payment_method_options_revolut_pay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; 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"]; us_bank_account?: components["schemas"]["payment_intent_payment_method_options_us_bank_account"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -13199,17 +13411,14 @@ export interface components { }; /** PaymentLinksResourceCustomFields */ payment_links_resource_custom_fields: { - /** @description Configuration for `type=dropdown` fields. */ - dropdown?: components["schemas"]["payment_links_resource_custom_fields_dropdown"] | null; + dropdown?: components["schemas"]["payment_links_resource_custom_fields_dropdown"]; /** @description String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters. */ key: string; label: components["schemas"]["payment_links_resource_custom_fields_label"]; - /** @description Configuration for `type=numeric` fields. */ - numeric?: components["schemas"]["payment_links_resource_custom_fields_numeric"] | null; + numeric?: components["schemas"]["payment_links_resource_custom_fields_numeric"]; /** @description Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. */ optional: boolean; - /** @description Configuration for `type=text` fields. */ - text?: components["schemas"]["payment_links_resource_custom_fields_text"] | null; + text?: components["schemas"]["payment_links_resource_custom_fields_text"]; /** * @description The type of the field. * @enum {string} @@ -13297,6 +13506,8 @@ export interface components { * @enum {string|null} */ capture_method?: "automatic" | "automatic_async" | "manual"; + /** @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. */ metadata: { [key: string]: string | undefined; @@ -13330,7 +13541,7 @@ export interface components { }; /** PaymentLinksResourceSubscriptionData */ payment_links_resource_subscription_data: { - /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ + /** @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 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. */ metadata: { @@ -13410,13 +13621,14 @@ export interface components { 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"]; sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; sofort?: components["schemas"]["payment_method_sofort"]; /** * @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" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "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"]; @@ -13645,7 +13857,7 @@ export interface components { * * Related guides: * - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations) - * - [Multiple payment method configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs) + * - [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_configuration: { @@ -13741,6 +13953,7 @@ export interface components { paypal?: components["schemas"]["payment_method_details_paypal"]; pix?: components["schemas"]["payment_method_details_pix"]; promptpay?: components["schemas"]["payment_method_details_promptpay"]; + revolut_pay?: components["schemas"]["payment_method_details_revolut_pay"]; 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"]; @@ -13865,6 +14078,11 @@ export interface components { amount_authorized?: number | null; /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ brand?: string | null; + /** + * 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"]["payment_method_details_card_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. */ @@ -13970,6 +14188,8 @@ export interface components { last4?: string | null; /** @description Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ network?: 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; /** @@ -13980,6 +14200,14 @@ export interface components { /** @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; }; + /** payment_method_details_card_present_offline */ + payment_method_details_card_present_offline: { + /** + * Format: unix-time + * @description Time at which the payment was collected while offline + */ + stored_at?: number | null; + }; /** payment_method_details_card_present_receipt */ payment_method_details_card_present_receipt: { /** @@ -14268,6 +14496,8 @@ export interface components { /** @description Bill reference generated by PromptPay */ reference?: string | null; }; + /** payment_method_details_revolut_pay */ + payment_method_details_revolut_pay: Record; /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ @@ -14280,7 +14510,7 @@ export interface components { fingerprint?: string | null; /** @description Last four characters of the IBAN. */ last4?: string | null; - /** @description ID of the mandate used to make this payment. */ + /** @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). */ mandate?: string | null; }; /** payment_method_details_sofort */ @@ -14847,6 +15077,8 @@ export interface components { */ setup_future_usage?: "none"; }; + /** payment_method_options_revolut_pay */ + payment_method_options_revolut_pay: Record; /** payment_method_options_sofort */ payment_method_options_sofort: { /** @@ -14919,6 +15151,8 @@ export interface components { payment_method_pix: Record; /** payment_method_promptpay */ payment_method_promptpay: Record; + /** payment_method_revolut_pay */ + payment_method_revolut_pay: Record; /** payment_method_sepa_debit */ payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ @@ -15063,17 +15297,14 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFields */ payment_pages_checkout_session_custom_fields: { - /** @description Configuration for `type=dropdown` fields. */ - dropdown?: components["schemas"]["payment_pages_checkout_session_custom_fields_dropdown"] | null; + dropdown?: components["schemas"]["payment_pages_checkout_session_custom_fields_dropdown"]; /** @description String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters. */ key: string; label: components["schemas"]["payment_pages_checkout_session_custom_fields_label"]; - /** @description Configuration for `type=numeric` fields. */ - numeric?: components["schemas"]["payment_pages_checkout_session_custom_fields_numeric"] | null; + numeric?: components["schemas"]["payment_pages_checkout_session_custom_fields_numeric"]; /** @description Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. */ optional: boolean; - /** @description Configuration for `type=text` fields. */ - text?: components["schemas"]["payment_pages_checkout_session_custom_fields_text"] | null; + text?: components["schemas"]["payment_pages_checkout_session_custom_fields_text"]; /** * @description The type of the field. * @enum {string} @@ -15354,6 +15585,7 @@ export interface components { person: { /** @description The account the person is associated with. */ account: string; + additional_tos_acceptances?: components["schemas"]["person_additional_tos_acceptances"]; address?: components["schemas"]["address"]; address_kana?: components["schemas"]["legal_entity_japan_address"] | null; address_kanji?: components["schemas"]["legal_entity_japan_address"] | null; @@ -15415,6 +15647,22 @@ export interface components { ssn_last_4_provided?: boolean; verification?: components["schemas"]["legal_entity_person_verification"]; }; + /** PersonAdditionalTOSAcceptance */ + person_additional_tos_acceptance: { + /** + * Format: unix-time + * @description The Unix timestamp marking when the legal guardian accepted the service agreement. + */ + date?: number | null; + /** @description The IP address from which the legal guardian accepted the service agreement. */ + ip?: string | null; + /** @description The user agent of the browser from which the legal guardian accepted the service agreement. */ + user_agent?: string | null; + }; + /** PersonAdditionalTOSAcceptances */ + person_additional_tos_acceptances: { + account: components["schemas"]["person_additional_tos_acceptance"]; + }; /** PersonFutureRequirements */ person_future_requirements: { /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ @@ -15436,6 +15684,8 @@ export interface components { director?: boolean | null; /** @description Whether the person has significant responsibility to control, manage, or direct the organization. */ executive?: boolean | null; + /** @description Whether the person is the legal guardian of the account's representative. */ + legal_guardian?: boolean | null; /** @description Whether the person is an owner of the account’s legal entity. */ owner?: boolean | null; /** @description The percent owned by the person of the account's legal entity. */ @@ -15741,7 +15991,7 @@ export interface components { default_allowed_updates: ("price" | "promotion_code" | "quantity")[]; /** @description Whether the feature is enabled. */ enabled: boolean; - /** @description The list of products that support subscription updates. */ + /** @description The list of up to 10 products that support subscription updates. */ products?: components["schemas"]["portal_subscription_update_product"][] | null; /** * @description Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. @@ -15916,7 +16166,7 @@ export interface components { /** ProductFeature */ product_feature: { /** @description The feature's name. Up to 80 characters long. */ - name: string; + name?: string; }; /** * PromotionCode @@ -16140,13 +16390,17 @@ export interface components { }; /** QuotesResourceSubscriptionDataSubscriptionData */ quotes_resource_subscription_data_subscription_data: { - /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ + /** @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; /** * Format: unix-time * @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. */ + metadata?: { + [key: string]: string | undefined; + } | null; /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ trial_period_days?: number | null; }; @@ -16781,7 +17035,7 @@ export interface components { /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `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"]["payment_method_details_card_checks"] | null; + checks?: components["schemas"]["setup_attempt_payment_method_details_card_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 Two-digit number representing the card's expiration month. */ @@ -16803,6 +17057,15 @@ export interface components { /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ wallet?: components["schemas"]["setup_attempt_payment_method_details_card_wallet"] | null; }; + /** setup_attempt_payment_method_details_card_checks */ + setup_attempt_payment_method_details_card_checks: { + /** @description If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + address_line1_check?: string | null; + /** @description If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + address_postal_code_check?: string | null; + /** @description If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`. */ + cvc_check?: string | null; + }; /** setup_attempt_payment_method_details_card_present */ setup_attempt_payment_method_details_card_present: { /** @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ @@ -17792,7 +18055,7 @@ export interface components { 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. */ + /** @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. */ discount?: components["schemas"]["discount"] | null; @@ -18103,7 +18366,7 @@ export interface components { default_payment_method?: (string | components["schemas"]["payment_method"]) | null; /** @description The default tax rates to apply to the subscription during this phase of the subscription schedule. */ default_tax_rates?: components["schemas"]["tax_rate"][] | null; - /** @description Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ + /** @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; /** * Format: unix-time @@ -18157,7 +18420,7 @@ export interface components { collection_method?: "charge_automatically" | "send_invoice"; /** @description ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription. */ + /** @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 subscription schedule's default invoice settings. */ invoice_settings?: components["schemas"]["invoice_setting_subscription_schedule_setting"] | null; @@ -18356,6 +18619,48 @@ export interface components { /** @description The [tax code](https://stripe.com/docs/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). + * + * 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). + * + * Related guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api) + */ + "tax.registration": { + /** + * Format: unix-time + * @description Time at which the registration becomes active. Measured in seconds since the Unix epoch. + */ + active_from: number; + /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + country: string; + country_options: components["schemas"]["tax_product_registrations_resource_country_options"]; + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** + * Format: unix-time + * @description If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch. + */ + expires_at?: number | null; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "tax.registration"; + /** + * @description The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`. + * @enum {string} + */ + status: "active" | "expired" | "scheduled"; + }; /** * TaxProductResourceTaxSettings * @description You can use Tax `Settings` to manage configurations used by Stripe Tax calculations. @@ -18571,6 +18876,127 @@ export interface components { /** @description Verified name. */ verified_name?: string | null; }; + /** TaxProductRegistrationsResourceCountryOptions */ + tax_product_registrations_resource_country_options: { + ae?: 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"]; + be?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + bg?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + ca?: components["schemas"]["tax_product_registrations_resource_country_options_canada"]; + ch?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + cl?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + co?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + cy?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + cz?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + de?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + dk?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + ee?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + es?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + 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"]; + gr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + hr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + 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"]; + 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"]; + kr?: 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"]; + mt?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + mx?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + my?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + nl?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + no?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + nz?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + 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"]; + 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"]; + si?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + sk?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + th?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + tr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + us?: components["schemas"]["tax_product_registrations_resource_country_options_united_states"]; + vn?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + za?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + }; + /** TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard */ + tax_product_registrations_resource_country_options_ca_province_standard: { + /** @description Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ + province: string; + }; + /** TaxProductRegistrationsResourceCountryOptionsCanada */ + tax_product_registrations_resource_country_options_canada: { + province_standard?: components["schemas"]["tax_product_registrations_resource_country_options_ca_province_standard"]; + /** + * @description Type of registration in Canada. + * @enum {string} + */ + type: "province_standard" | "simplified" | "standard"; + }; + /** TaxProductRegistrationsResourceCountryOptionsDefault */ + tax_product_registrations_resource_country_options_default: { + /** + * @description Type of registration in `country`. + * @enum {string} + */ + type: "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"; + }; + /** TaxProductRegistrationsResourceCountryOptionsEurope */ + tax_product_registrations_resource_country_options_europe: { + standard?: components["schemas"]["tax_product_registrations_resource_country_options_eu_standard"]; + /** + * @description Type of registration in an EU country. + * @enum {string} + */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** TaxProductRegistrationsResourceCountryOptionsSimplified */ + tax_product_registrations_resource_country_options_simplified: { + /** + * @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"]; + local_lease_tax?: components["schemas"]["tax_product_registrations_resource_country_options_us_local_lease_tax"]; + /** @description Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ + state: string; + /** + * @description Type of registration in the US. + * @enum {string} + */ + type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_sales_tax"; + }; + /** TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax */ + tax_product_registrations_resource_country_options_us_local_amusement_tax: { + /** @description A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ + jurisdiction: string; + }; + /** TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax */ + tax_product_registrations_resource_country_options_us_local_lease_tax: { + /** @description A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. */ + jurisdiction: string; + }; /** TaxProductResourceCustomerDetails */ tax_product_resource_customer_details: { /** @description The customer's postal address (for example, home or business location). */ @@ -18828,6 +19254,7 @@ export interface components { * @enum {string} */ object: "terminal.configuration"; + offline?: components["schemas"]["terminal_configuration_configuration_resource_offline_config"]; tipping?: components["schemas"]["terminal_configuration_configuration_resource_tipping"]; verifone_p400?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; }; @@ -18928,6 +19355,11 @@ export interface components { /** @description A File ID representing an image you would like displayed on the reader. */ splashscreen?: string | components["schemas"]["file"]; }; + /** 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; + }; /** TerminalConfigurationConfigurationResourceTipping */ terminal_configuration_configuration_resource_tipping: { aud?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; @@ -19259,7 +19691,7 @@ export interface components { * @enum {string} */ object: "topup"; - /** @description For most Stripe users, the source of every top-up is a bank account. This hash is then the [source object](https://stripe.com/docs/api#source_object) describing that bank account. */ + /** @description The source field is deprecated. It might not always be present in the API response. */ source?: components["schemas"]["source"] | null; /** @description Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter. */ statement_descriptor?: string | null; @@ -20902,6 +21334,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + revolut_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ sepa_debit_payments?: { requested?: boolean; }; @@ -21133,6 +21569,10 @@ export interface operations { * @description Options for customizing how the account functions within Stripe. */ settings?: { + /** bacs_debit_payments_specs */ + bacs_debit_payments?: { + display_name?: string; + }; /** branding_settings_specs */ branding?: { icon?: string; @@ -21434,6 +21874,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + revolut_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ sepa_debit_payments?: { requested?: boolean; }; @@ -21663,6 +22107,10 @@ export interface operations { * @description Options for customizing how the account functions within Stripe. */ settings?: { + /** bacs_debit_payments_specs */ + bacs_debit_payments?: { + display_name?: string; + }; /** branding_settings_specs */ branding?: { icon?: string; @@ -22486,6 +22934,7 @@ export interface operations { relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; representative?: boolean; }; @@ -22547,6 +22996,19 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** + * person_additional_tos_acceptances_specs + * @description Details on the legal guardian's acceptance of the required Stripe agreements. + */ + additional_tos_acceptances?: { + /** settings_terms_of_service_specs */ + account?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string | ""; + }; + }; /** * address_specs * @description The person's address. @@ -22666,6 +23128,7 @@ export interface operations { relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; percent_ownership?: number | ""; representative?: boolean; @@ -22765,6 +23228,19 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** + * person_additional_tos_acceptances_specs + * @description Details on the legal guardian's acceptance of the required Stripe agreements. + */ + additional_tos_acceptances?: { + /** settings_terms_of_service_specs */ + account?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string | ""; + }; + }; /** * address_specs * @description The person's address. @@ -22884,6 +23360,7 @@ export interface operations { relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; percent_ownership?: number | ""; representative?: boolean; @@ -22980,6 +23457,7 @@ export interface operations { relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; representative?: boolean; }; @@ -23041,6 +23519,19 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** + * person_additional_tos_acceptances_specs + * @description Details on the legal guardian's acceptance of the required Stripe agreements. + */ + additional_tos_acceptances?: { + /** settings_terms_of_service_specs */ + account?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string | ""; + }; + }; /** * address_specs * @description The person's address. @@ -23160,6 +23651,7 @@ export interface operations { relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; percent_ownership?: number | ""; representative?: boolean; @@ -23259,6 +23751,19 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** + * person_additional_tos_acceptances_specs + * @description Details on the legal guardian's acceptance of the required Stripe agreements. + */ + additional_tos_acceptances?: { + /** settings_terms_of_service_specs */ + account?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string | ""; + }; + }; /** * address_specs * @description The person's address. @@ -23378,6 +23883,7 @@ export interface operations { relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; percent_ownership?: number | ""; representative?: boolean; @@ -24249,7 +24755,7 @@ export interface operations { 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`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; header?: never; @@ -24354,7 +24860,7 @@ export interface operations { 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`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; header?: never; @@ -24965,7 +25471,7 @@ export interface operations { /** @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#on-behalf-of). */ on_behalf_of?: string; /** - * radar_options + * radar_options_with_hidden_options * @description Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. */ radar_options?: { @@ -25695,6 +26201,8 @@ export interface operations { payment_link?: string; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; + /** @description Only return the Checkout Sessions matching the given status. */ + status?: "complete" | "expired" | "open"; /** @description Only return the Checkout Session for the subscription specified. */ subscription?: string; }; @@ -25790,7 +26298,7 @@ export interface operations { /** @enum {string} */ terms_of_service?: "none" | "required"; }; - /** @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). */ + /** @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 2 fields are supported. */ custom_fields?: { @@ -25837,10 +26345,10 @@ export interface operations { message: string; } | ""; }; - /** @description ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card + /** @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) - * will be used if it’s a card, and otherwise the most recent 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. + * 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 does not have a valid `email`, Checkout will set the email entered during the session on the Customer. @@ -26193,6 +26701,11 @@ export interface operations { expires_after_seconds?: number; }; /** payment_method_options_param */ + revolut_pay?: { + /** @enum {string} */ + setup_future_usage?: "none" | "off_session"; + }; + /** payment_method_options_param */ sepa_debit?: { /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -26225,8 +26738,8 @@ export interface operations { }; /** @description A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. * - * In `payment` and `subscription` mode, you can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). - * It is required in `setup` mode. + * 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. * * Read more about the supported payment methods and their requirements in our [payment * method details guide](/docs/payments/checkout/payment-methods). @@ -26234,7 +26747,7 @@ export interface operations { * If multiple payment methods are passed, Checkout will dynamically reorder them to * prioritize the most relevant payment methods based on the customer's location and * other characteristics. */ - payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip")[]; + payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip")[]; /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -26358,8 +26871,9 @@ export interface operations { }; /** @description The URL to which Stripe should send customers when payment or setup * is complete. - * 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). */ + * This parameter is not allowed if ui_mode is `embedded`. 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). */ success_url?: string; /** * tax_id_collection_params @@ -26966,6 +27480,11 @@ export interface operations { description?: string; invoice_line_item?: string; quantity?: number; + tax_amounts?: { + amount: number; + tax_rate: string; + taxable_amount: number; + }[] | ""; tax_rates?: string[] | ""; /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; @@ -27040,6 +27559,11 @@ export interface operations { description?: string; invoice_line_item?: string; quantity?: number; + tax_amounts?: { + amount: number; + tax_rate: string; + taxable_amount: number; + }[] | ""; tax_rates?: string[] | ""; /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; @@ -27119,6 +27643,11 @@ export interface operations { description?: string; invoice_line_item?: string; quantity?: number; + tax_amounts?: { + amount: number; + tax_rate: string; + taxable_amount: number; + }[] | ""; tax_rates?: string[] | ""; /** @enum {string} */ type: "custom_line_item" | "invoice_line_item"; @@ -28991,7 +29520,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" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path: { @@ -33377,6 +33906,118 @@ export interface operations { }; }; }; + PostInvoicesInvoiceLinesLineItemId: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Invoice ID of line item */ + invoice: string; + /** @description Invoice line item ID */ + line_item_id: string; + }; + cookie?: never; + }; + 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. If you want to apply a credit to the customer's account, pass a negative amount. */ + amount?: number; + /** @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 line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. */ + discountable?: boolean; + /** @description The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ + discounts?: { + coupon?: string; + discount?: 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 | undefined; + } | ""; + /** + * 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. + */ + period?: { + /** Format: unix-time */ + end: number; + /** Format: unix-time */ + start: number; + }; + /** @description The ID of the price object. */ + 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. + */ + price_data?: { + currency: string; + product?: string; + /** product_data */ + product_data?: { + description?: string; + images?: string[]; + metadata?: { + [key: string]: string | undefined; + }; + name: string; + tax_code?: string; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: 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. */ + tax_amounts?: { + amount: number; + /** tax_rate_data_param */ + tax_rate_data: { + country?: string; + description?: string; + display_name: string; + inclusive: boolean; + jurisdiction?: string; + percentage: number; + state?: string; + /** @enum {string} */ + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "service_tax" | "vat"; + }; + 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. */ + tax_rates?: string[] | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["line_item"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostInvoicesInvoiceMarkUncollectible: { parameters: { query?: never; @@ -35842,6 +36483,8 @@ export interface operations { session?: string; }; /** param */ + revolut_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -35851,7 +36494,7 @@ export interface operations { country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -35977,8 +36620,6 @@ export interface operations { } | ""; card_present?: { request_extended_authorization?: boolean; - /** @enum {string} */ - request_incremental_authorization?: "if_available" | "never"; request_incremental_authorization_support?: boolean; } | ""; cashapp?: { @@ -36081,6 +36722,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + revolut_pay?: { + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: Record; @@ -36170,7 +36815,7 @@ export interface operations { statement_descriptor_suffix?: string; /** * transfer_data_creation_params - * @description The parameters that you can use to automatically create a Transfer after the payment succeeds. + * @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). */ transfer_data?: { @@ -36452,6 +37097,8 @@ export interface operations { session?: string; }; /** param */ + revolut_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -36461,7 +37108,7 @@ export interface operations { country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -36587,8 +37234,6 @@ export interface operations { } | ""; card_present?: { request_extended_authorization?: boolean; - /** @enum {string} */ - request_incremental_authorization?: "if_available" | "never"; request_incremental_authorization_support?: boolean; } | ""; cashapp?: { @@ -36691,6 +37336,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + revolut_pay?: { + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: Record; @@ -37120,6 +37769,8 @@ export interface operations { session?: string; }; /** param */ + revolut_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -37129,7 +37780,7 @@ export interface operations { country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -37255,8 +37906,6 @@ export interface operations { } | ""; card_present?: { request_extended_authorization?: boolean; - /** @enum {string} */ - request_incremental_authorization?: "if_available" | "never"; request_incremental_authorization_support?: boolean; } | ""; cashapp?: { @@ -37359,6 +38008,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "none"; } | ""; + revolut_pay?: { + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: Record; @@ -37782,6 +38435,7 @@ export interface operations { payment_intent_data?: { /** @enum {string} */ capture_method?: "automatic" | "automatic_async" | "manual"; + description?: string; metadata?: { [key: string]: string | undefined; }; @@ -38054,6 +38708,7 @@ export interface operations { * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. */ payment_intent_data?: { + description?: string | ""; metadata?: { [key: string]: string | undefined; } | ""; @@ -39286,7 +39941,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" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path?: never; @@ -39543,6 +40198,11 @@ export interface operations { radar_options?: { session?: string; }; + /** + * param + * @description If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. + */ + revolut_pay?: Record; /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. @@ -39562,7 +40222,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" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "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. @@ -41584,6 +42244,9 @@ export interface operations { subscription_data?: { description?: string; effective_date?: "current_period_end" | number | ""; + metadata?: { + [key: string]: string | undefined; + }; trial_period_days?: number | ""; }; /** @description ID of the test clock to attach to the quote. */ @@ -41749,6 +42412,9 @@ export interface operations { subscription_data?: { description?: string | ""; effective_date?: "current_period_end" | number | ""; + metadata?: { + [key: string]: string | undefined; + }; trial_period_days?: number | ""; }; /** @description The data with which to automatically create a Transfer for each of the invoices. */ @@ -42883,7 +43549,7 @@ export interface operations { interval_start?: number; payout?: string; /** @enum {string} */ - reporting_category?: "advance" | "advance_funding" | "anticipation_repayment" | "charge" | "charge_failure" | "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" | "obligation" | "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"; + reporting_category?: "advance" | "advance_funding" | "anticipation_repayment" | "charge" | "charge_failure" | "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" | "obligation" | "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"; }; @@ -43479,6 +44145,8 @@ export interface operations { session?: string; }; /** param */ + revolut_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -43488,7 +44156,7 @@ export interface operations { country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -43807,6 +44475,8 @@ export interface operations { session?: string; }; /** param */ + revolut_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -43816,7 +44486,7 @@ export interface operations { country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -44130,6 +44800,8 @@ export interface operations { session?: string; }; /** param */ + revolut_pay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -44139,7 +44811,7 @@ export interface operations { country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -46266,7 +46938,7 @@ export interface operations { 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[] | ""; - /** @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. */ + /** @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; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -46609,7 +47281,7 @@ export interface operations { 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[] | ""; - /** @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. */ + /** @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 | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -47074,6 +47746,547 @@ export interface operations { }; }; }; + GetTaxRegistrations: { + 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; + /** @description The status of the Tax Registration. */ + status?: "active" | "all" | "expired" | "scheduled"; + }; + 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"]["tax.registration"][]; + /** @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"]; + }; + }; + }; + }; + PostTaxRegistrations: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch. */ + active_from: "now" | number; + /** @description Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). */ + country: string; + /** + * country_options + * @description Specific options for a registration in the specified `country`. + */ + country_options: { + /** default */ + ae?: { + /** @enum {string} */ + type: "standard"; + }; + /** europe */ + at?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** default */ + au?: { + /** @enum {string} */ + type: "standard"; + }; + /** europe */ + be?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + bg?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** canada */ + ca?: { + /** province_standard */ + province_standard?: { + province: string; + }; + /** @enum {string} */ + type: "province_standard" | "simplified" | "standard"; + }; + /** default */ + ch?: { + /** @enum {string} */ + type: "standard"; + }; + /** simplified */ + cl?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ + co?: { + /** @enum {string} */ + type: "simplified"; + }; + /** europe */ + cy?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + cz?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + de?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + dk?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + ee?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + es?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + fi?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + fr?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** default */ + gb?: { + /** @enum {string} */ + type: "standard"; + }; + /** europe */ + gr?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + hr?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + hu?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** simplified */ + id?: { + /** @enum {string} */ + type: "simplified"; + }; + /** europe */ + ie?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** default */ + is?: { + /** @enum {string} */ + type: "standard"; + }; + /** europe */ + it?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** default */ + jp?: { + /** @enum {string} */ + type: "standard"; + }; + /** simplified */ + kr?: { + /** @enum {string} */ + type: "simplified"; + }; + /** europe */ + lt?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + lu?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + lv?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + mt?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** simplified */ + mx?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ + my?: { + /** @enum {string} */ + type: "simplified"; + }; + /** europe */ + nl?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** default */ + no?: { + /** @enum {string} */ + type: "standard"; + }; + /** default */ + nz?: { + /** @enum {string} */ + type: "standard"; + }; + /** europe */ + pl?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + pt?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + ro?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** simplified */ + sa?: { + /** @enum {string} */ + type: "simplified"; + }; + /** europe */ + se?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** default */ + sg?: { + /** @enum {string} */ + type: "standard"; + }; + /** europe */ + si?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** europe */ + sk?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme: "small_seller" | "standard"; + }; + /** @enum {string} */ + type: "ioss" | "oss_non_union" | "oss_union" | "standard"; + }; + /** simplified */ + th?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ + tr?: { + /** @enum {string} */ + type: "simplified"; + }; + /** united_states */ + us?: { + /** local_amusement_tax */ + local_amusement_tax?: { + jurisdiction: string; + }; + /** local_lease_tax */ + local_lease_tax?: { + jurisdiction: string; + }; + state: string; + /** @enum {string} */ + type: "local_amusement_tax" | "local_lease_tax" | "state_communications_tax" | "state_sales_tax"; + }; + /** simplified */ + vn?: { + /** @enum {string} */ + type: "simplified"; + }; + /** default */ + za?: { + /** @enum {string} */ + type: "standard"; + }; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * Format: unix-time + * @description If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch. + */ + expires_at?: number; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["tax.registration"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTaxRegistrationsId: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch. */ + active_from?: "now" | number; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch. */ + expires_at?: "now" | number | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["tax.registration"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetTaxSettings: { parameters: { query?: { @@ -47765,6 +48978,10 @@ export interface operations { }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description Configurations for collecting transactions offline. */ + offline?: { + enabled: boolean; + } | ""; /** @description Tipping configurations for readers supporting on-reader tips */ tipping?: { /** currency_specific_config */ @@ -47939,6 +49156,10 @@ export interface operations { } | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description Configurations for collecting transactions offline. */ + offline?: { + enabled: boolean; + } | ""; /** @description Tipping configurations for readers supporting on-reader tips */ tipping?: { /** currency_specific_config */ @@ -48928,6 +50149,7 @@ export interface operations { postal_code?: string; state?: string; terminal_id?: string; + url?: string; }; /** * network_data_specs @@ -48945,10 +50167,22 @@ export interface operations { address_line1_check?: "match" | "mismatch" | "not_provided"; /** @enum {string} */ address_postal_code_check?: "match" | "mismatch" | "not_provided"; + /** authentication_exemption_specs */ + authentication_exemption?: { + /** @enum {string} */ + claimed_by: "acquirer" | "issuer"; + /** @enum {string} */ + type: "low_value_transaction" | "transaction_risk_analysis"; + }; /** @enum {string} */ cvc_check?: "match" | "mismatch" | "not_provided"; /** @enum {string} */ expiry_check?: "match" | "mismatch" | "not_provided"; + /** three_d_secure_specs */ + three_d_secure?: { + /** @enum {string} */ + result: "attempt_acknowledged" | "authenticated" | "failed" | "required"; + }; }; /** * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. @@ -49372,6 +50606,7 @@ export interface operations { postal_code?: string; state?: string; terminal_id?: string; + url?: string; }; /** * purchase_details_specs @@ -49476,6 +50711,7 @@ export interface operations { postal_code?: string; state?: string; terminal_id?: string; + url?: string; }; /** * purchase_details_specs @@ -50595,6 +51831,16 @@ export interface operations { * @description Information for the person this token represents. */ person?: { + /** person_additional_tos_acceptances_specs */ + additional_tos_acceptances?: { + /** settings_terms_of_service_specs */ + account?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string | ""; + }; + }; /** address_specs */ address?: { city?: string; @@ -50675,6 +51921,7 @@ export interface operations { relationship?: { director?: boolean; executive?: boolean; + legal_guardian?: boolean; owner?: boolean; percent_ownership?: number | ""; representative?: boolean; @@ -53243,13 +54490,13 @@ export interface operations { * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ - api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16"; + 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"; /** @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_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + enabled_events: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ @@ -53337,7 +54584,7 @@ export interface operations { /** @description Disable the webhook endpoint if set to true. */ disabled?: boolean; /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ - enabled_events?: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + enabled_events?: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index 5cba47d51..9da338aad 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -183,10 +183,26 @@ components: properties: display_name: description: >- - The Bacs Direct Debit Display Name for this account. For payments - made with Bacs Direct Debit, this will appear on the mandate, and as - the statement descriptor. + The Bacs Direct Debit display name for this account. For payments + made with Bacs Direct Debit, this name appears on the mandate as the + statement descriptor. Mobile banking apps display it as the name of + the business. To use custom branding, set the Bacs Direct Debit + Display Name during or right after creation. Custom branding incurs + an additional monthly fee for the platform. The fee appears 5 + business days after requesting Bacs. If you don't set the display + name before requesting Bacs capability, it's automatically set as + "Stripe" and the account is onboarded to Stripe branding, which is + free. maxLength: 5000 + nullable: true + type: string + service_user_number: + description: >- + The Bacs Direct Debit Service user number for this account. For + payments made with Bacs Direct Debit, this number is a unique + identifier of the account with our banking partners. + maxLength: 5000 + nullable: true type: string title: AccountBacsDebitPaymentsSettings type: object @@ -556,6 +572,15 @@ components: - inactive - pending type: string + revolut_pay_payments: + description: >- + The status of the RevolutPay capability of the account, or whether + the account can directly process RevolutPay payments. + enum: + - active + - inactive + - pending + type: string sepa_debit_payments: description: >- The status of the SEPA Direct Debits payments capability of the @@ -942,9 +967,7 @@ components: disabled_reason: description: >- This is typed as a string for consistency with - `requirements.disabled_reason`, but it safe to assume - `future_requirements.disabled_reason` is empty because fields in - `future_requirements` will never disable the account. + `requirements.disabled_reason`. maxLength: 5000 nullable: true type: string @@ -1165,10 +1188,14 @@ components: type: array disabled_reason: description: >- - If the account is disabled, this string describes why. Can be + If the account is disabled, this string describes why. [Learn more + about handling verification + issues](https://stripe.com/docs/connect/handling-api-verification). + Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, - `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, - `rejected.terms_of_service`, `rejected.other`, `under_review`, or + `listed`, `platform_paused`, `rejected.fraud`, + `rejected.incomplete_verification`, `rejected.listed`, + `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`. maxLength: 5000 nullable: true @@ -1248,10 +1275,43 @@ components: description: The code for the type of error. enum: - invalid_address_city_state_postal_code + - invalid_address_highway_contract_box + - invalid_address_private_mailbox + - invalid_business_profile_name + - invalid_business_profile_name_denylisted + - invalid_company_name_denylisted + - invalid_dob_age_over_maximum - invalid_dob_age_under_18 + - invalid_dob_age_under_minimum + - invalid_product_description_length + - invalid_product_description_url_match - invalid_representative_country + - invalid_statement_descriptor_business_mismatch + - invalid_statement_descriptor_denylisted + - invalid_statement_descriptor_length + - invalid_statement_descriptor_prefix_denylisted + - invalid_statement_descriptor_prefix_mismatch - invalid_street_address + - invalid_tax_id + - invalid_tax_id_format - invalid_tos_acceptance + - invalid_url_denylisted + - invalid_url_format + - invalid_url_web_presence_detected + - invalid_url_website_business_information_mismatch + - invalid_url_website_empty + - invalid_url_website_inaccessible + - invalid_url_website_inaccessible_geoblocked + - invalid_url_website_inaccessible_password_protected + - invalid_url_website_incomplete + - invalid_url_website_incomplete_cancellation_policy + - invalid_url_website_incomplete_customer_service_details + - invalid_url_website_incomplete_legal_restrictions + - invalid_url_website_incomplete_refund_policy + - invalid_url_website_incomplete_return_policy + - invalid_url_website_incomplete_terms_and_conditions + - invalid_url_website_incomplete_under_construction + - invalid_url_website_other - invalid_value_other - verification_directors_mismatch - verification_document_address_mismatch @@ -2019,7 +2079,7 @@ components: instant_available: description: Funds that you can pay out using Instant Payouts. items: - $ref: '#/components/schemas/balance_amount' + $ref: '#/components/schemas/balance_amount_net' type: array issuing: $ref: '#/components/schemas/balance_detail' @@ -2094,6 +2154,28 @@ components: title: BalanceAmountBySourceType type: object x-expandableFields: [] + balance_amount_net: + description: '' + properties: + amount: + description: Balance amount. + type: integer + currency: + description: >- + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + type: string + source_types: + $ref: '#/components/schemas/balance_amount_by_source_type' + required: + - amount + - currency + title: BalanceAmountNet + type: object + x-expandableFields: + - source_types balance_detail: description: '' properties: @@ -2261,8 +2343,8 @@ components: `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, - `payout`, `payout_cancel`, `payout_failure`, `refund`, - `refund_failure`, `reserve_transaction`, `reserved_funds`, + `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, + `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and @@ -2294,6 +2376,7 @@ components: - payment_failure_refund - payment_refund - payment_reversal + - payment_unreconciled - payout - payout_cancel - payout_failure @@ -2489,15 +2572,16 @@ components: 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 transfer sent to this bank account - fails, we'll set the status to `errored` and will not continue to - send transfers until the bank details are updated. + `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 transfer fails, the status is set to - `errored` and transfers are stopped until account details are - updated. In India, if we can't [verify the owner of the bank + `verification_failed`. If a payouts fails, the status is set to + `errored` and scheduled payouts are stopped until account details + are updated. In 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 @@ -3313,9 +3397,10 @@ components: type: string status: description: >- - For external accounts, possible values are `new` and `errored`. If a - transfer fails, the status is set to `errored` and transfers are - stopped until account details are updated. + For external accounts that are cards, possible values are `new` and + `errored`. If a payout fails, the status is set to `errored` and + [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) + are stopped until account details are updated. maxLength: 5000 nullable: true type: string @@ -5364,6 +5449,58 @@ components: title: CheckoutPaynowPaymentMethodOptions type: object x-expandableFields: [] + checkout_paypal_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + preferred_locale: + description: >- + Preferred locale of the PayPal checkout page that the customer is + redirected to. + maxLength: 5000 + nullable: true + type: string + reference: + description: >- + A reference of the PayPal transaction visible to customer which is + mapped to PayPal's invoice ID. This must be a globally unique ID if + you have configured in your PayPal settings to block multiple + payments per invoice ID. + maxLength: 5000 + nullable: true + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter 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. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: CheckoutPaypalPaymentMethodOptions + type: object + x-expandableFields: [] checkout_pix_payment_method_options: description: '' properties: @@ -5374,6 +5511,12 @@ components: title: CheckoutPixPaymentMethodOptions type: object x-expandableFields: [] + checkout_revolut_pay_payment_method_options: + description: '' + properties: {} + title: CheckoutRevolutPayPaymentMethodOptions + type: object + x-expandableFields: [] checkout_sepa_debit_payment_method_options: description: '' properties: @@ -5453,8 +5596,12 @@ components: $ref: '#/components/schemas/checkout_p24_payment_method_options' paynow: $ref: '#/components/schemas/checkout_paynow_payment_method_options' + paypal: + $ref: '#/components/schemas/checkout_paypal_payment_method_options' pix: $ref: '#/components/schemas/checkout_pix_payment_method_options' + revolut_pay: + $ref: '#/components/schemas/checkout_revolut_pay_payment_method_options' sepa_debit: $ref: '#/components/schemas/checkout_sepa_debit_payment_method_options' sofort: @@ -5486,7 +5633,9 @@ components: - oxxo - p24 - paynow + - paypal - pix + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -6493,15 +6642,22 @@ components: x-stripeBypassValidation: true delinquent: description: >- - If Stripe bills the customer's latest invoice by automatically - charging and the latest charge fails, it sets `delinquent`` to - `true``. If Stripe bills the invoice by sending it, and the invoice - isn't paid by the due date, it also sets `delinquent`` to `true`. + 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 you care whether the customer has paid their most recent + subscription invoice, use `subscription.status` instead. Paying or + marking uncollectible any customer invoice regardless of whether it + is the latest invoice for a subscription will always set this field + to `false`. nullable: true type: boolean description: @@ -7276,6 +7432,7 @@ components: - refunded_from_payment - return_canceled - return_initiated + - transferred_to_balance - unapplied_from_payment type: string unapplied_from_payment: @@ -8802,10 +8959,9 @@ components: [account settings](https://dashboard.stripe.com/account/webhooks). Learn how - to [listen for events] + to [listen for events](https://stripe.com/docs/webhooks) - (/docs/webhooks) so that your integration can automatically trigger - reactions. + so that your integration can automatically trigger reactions. When using [Connect](https://stripe.com/docs/connect), you can also @@ -8888,33 +9044,64 @@ components: x-resourceId: event exchange_rate: description: >- - `Exchange Rate` objects allow you to determine the rates that Stripe is + `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 - currently using to convert from one currency to another. Since this - number is + rate (for example, to dynamically price an item for a user with a + default - variable throughout the day, there are various reasons why you might - want to + payment in a foreign currency). - 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. - If you want a guarantee that the charge is made with a certain exchange - rate + *[Note: this integration path is supported but no longer recommended]* + Additionally, - you expect is current, you can pass in `exchange_rate` to charges - endpoints. + you can guarantee that a charge is made with an exchange rate that you + expect is - If the value is no longer up to date, the charge won't go through. - Please + current. To do so, you must pass in the exchange_rate to charges + endpoints. If the - refer to our [Exchange Rates - API](https://stripe.com/docs/exchange-rates) guide for more + value is no longer up to date, the charge won't go through. Please refer + to our - details. + [Using with charges](https://stripe.com/docs/exchange-rates) guide for + more details. + + + ----- + + +   + + + *This Exchange Rates API is a Beta Service and is subject to Stripe's + terms of service. You may use the API solely for the purpose of + transacting on Stripe. For example, the API may be queried in order to:* + + + - *localize prices for processing payments on Stripe* + + - *reconcile Stripe transactions* + + - *determine how much money to send to a connected account* + + - *determine app fees to charge a connected account* + + + *Using this Exchange Rates API beta for any purpose other than to + transact on Stripe is strictly prohibited and constitutes a violation of + Stripe's terms of service.* properties: id: description: >- @@ -9190,7 +9377,7 @@ components: - has_more - object - url - title: FileFileLinkList + title: FileResourceFileLinkList type: object x-expandableFields: - data @@ -9844,11 +10031,35 @@ components: type: object x-expandableFields: - financial_addresses + funding_instructions_bank_transfer_aba_record: + description: ABA Records contain U.S. bank account details per the ABA format. + properties: + account_number: + description: The ABA account number + maxLength: 5000 + type: string + bank_name: + description: The bank name + maxLength: 5000 + type: string + routing_number: + description: The ABA routing number + maxLength: 5000 + type: string + required: + - account_number + - bank_name + - routing_number + title: FundingInstructionsBankTransferABARecord + type: object + x-expandableFields: [] funding_instructions_bank_transfer_financial_address: description: >- FinancialAddresses contain identifying information that resolves to a FinancialAccount. properties: + aba: + $ref: '#/components/schemas/funding_instructions_bank_transfer_aba_record' iban: $ref: '#/components/schemas/funding_instructions_bank_transfer_iban_record' sort_code: @@ -9860,20 +10071,27 @@ components: description: The payment networks supported by this FinancialAddress items: enum: + - ach - bacs + - domestic_wire_us - fps - sepa - spei + - swift - zengin type: string x-stripeBypassValidation: true type: array + swift: + $ref: '#/components/schemas/funding_instructions_bank_transfer_swift_record' type: description: The type of financial address enum: + - aba - iban - sort_code - spei + - swift - zengin type: string x-stripeBypassValidation: true @@ -9885,9 +10103,11 @@ components: title: FundingInstructionsBankTransferFinancialAddress type: object x-expandableFields: + - aba - iban - sort_code - spei + - swift - zengin funding_instructions_bank_transfer_iban_record: description: Iban Records contain E.U. bank account details per the SEPA format. @@ -9964,6 +10184,28 @@ components: title: FundingInstructionsBankTransferSpeiRecord type: object x-expandableFields: [] + funding_instructions_bank_transfer_swift_record: + description: SWIFT Records contain U.S. bank account details per the SWIFT format. + properties: + account_number: + description: The account number + maxLength: 5000 + type: string + bank_name: + description: The bank name + maxLength: 5000 + type: string + swift_code: + description: The SWIFT code + maxLength: 5000 + type: string + required: + - account_number + - bank_name + - swift_code + title: FundingInstructionsBankTransferSwiftRecord + type: object + x-expandableFields: [] funding_instructions_bank_transfer_zengin_record: description: Zengin Records contain Japan bank account details per the Zengin format. properties: @@ -12732,8 +12974,10 @@ components: amount: description: >- The total amount that was authorized or rejected. This amount is in - the card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + `currency` and in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). `amount` + should be the same as `merchant_amount`, unless `currency` and + `merchant_currency` are different. type: integer amount_details: anyOf: @@ -12780,7 +13024,9 @@ components: type: integer currency: description: >- - Three-letter [ISO currency + The currency of the cardholder. This currency can be different from + the currency presented at authorization and the `merchant_currency` + field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -12799,11 +13045,15 @@ components: The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). + `merchant_amount` should be the same as `amount`, unless + `merchant_currency` and `currency` are different. type: integer merchant_currency: description: >- - The currency that was presented to the cardholder for the - authorization. Three-letter [ISO currency + The local currency that was presented to the cardholder for the + authorization. This currency can be different from the cardholder + currency and the `currency` field on this authorization. + Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -13463,7 +13713,9 @@ components: 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 through Stripe. + can [view and manage these + tokens](https://stripe.com/docs/issuing/controls/token-management) + through Stripe. properties: card: anyOf: @@ -13675,6 +13927,13 @@ components: you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object + network_data: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_network_data' + description: >- + Details about the transaction, such as processing dates, set by the + card network. + nullable: true object: description: >- String representing the object's type. Objects of the same type @@ -13750,6 +14009,7 @@ components: - cardholder - dispute - merchant_data + - network_data - purchase_details - token - treasury @@ -13768,6 +14028,30 @@ components: title: IssuingAuthorizationAmountDetails type: object x-expandableFields: [] + issuing_authorization_authentication_exemption: + description: '' + properties: + claimed_by: + description: >- + The entity that requested the exemption, either the acquiring + merchant or the Issuing user. + enum: + - acquirer + - issuer + type: string + type: + description: The specific exemption claimed for this authorization. + enum: + - low_value_transaction + - transaction_risk_analysis + type: string + x-stripeBypassValidation: true + required: + - claimed_by + - type + title: IssuingAuthorizationAuthenticationExemption + type: object + x-expandableFields: [] issuing_authorization_merchant_data: description: '' properties: @@ -13820,6 +14104,11 @@ components: maxLength: 5000 nullable: true type: string + url: + description: URL provided by the merchant on a 3DS request + maxLength: 5000 + nullable: true + type: string required: - category - category_code @@ -13838,6 +14127,21 @@ components: maxLength: 5000 nullable: true type: string + system_trace_audit_number: + description: >- + The System Trace Audit Number (STAN) is a 6-digit identifier + assigned by the acquirer. Prefer `network_data.transaction_id` if + present, unless you have special requirements. + maxLength: 5000 + nullable: true + type: string + transaction_id: + description: >- + Unique identifier for the authorization assigned by the card network + used to match subsequent messages, disputes, and transactions. + maxLength: 5000 + nullable: true + type: string title: IssuingAuthorizationNetworkData type: object x-expandableFields: [] @@ -13882,6 +14186,12 @@ components: merchant_currency: description: The local currency the merchant is requesting to authorize. type: string + network_risk_score: + description: >- + The card network's estimate of the likelihood that an authorization + is fraudulent. Takes on values between 1 and 99. + nullable: true + type: integer required: - amount - currency @@ -13954,6 +14264,12 @@ components: currency](https://stripe.com/docs/currencies). maxLength: 5000 type: string + network_risk_score: + description: >- + The card network's estimate of the likelihood that an authorization + is fraudulent. Takes on values between 1 and 99. + nullable: true + type: integer reason: description: >- When an authorization is approved or declined by you or by Stripe, @@ -13977,12 +14293,20 @@ components: x-stripeBypassValidation: true reason_message: description: >- - If approve/decline decision is directly responsed to the webhook - with json payload and if the response is invalid (e.g., parsing - errors), we surface the detailed message via this field. + If the `request_history.reason` is `webhook_error` because the + direct webhook response is invalid (for example, parsing errors or + missing parameters), we surface a more detailed error message via + this field. maxLength: 5000 nullable: true type: string + requested_at: + description: >- + Time when the card network received an authorization request from + the acquirer in UTC. Referred to by networks as transmission time. + format: unix-time + nullable: true + type: integer required: - amount - approved @@ -13995,6 +14319,23 @@ components: type: object x-expandableFields: - amount_details + issuing_authorization_three_d_secure: + description: '' + properties: + result: + description: The outcome of the 3D Secure authentication request. + enum: + - attempt_acknowledged + - authenticated + - failed + - required + type: string + x-stripeBypassValidation: true + required: + - result + title: IssuingAuthorizationThreeDSecure + type: object + x-expandableFields: [] issuing_authorization_treasury: description: '' properties: @@ -14051,6 +14392,12 @@ components: - mismatch - not_provided type: string + authentication_exemption: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_authentication_exemption + description: The exemption applied to this authorization. + nullable: true cvc_check: description: >- Whether the cardholder provided a CVC and if it matched Stripe’s @@ -14076,6 +14423,11 @@ components: maxLength: 5000 nullable: true type: string + three_d_secure: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_three_d_secure' + description: 3D Secure details. + nullable: true required: - address_line1_check - address_postal_code_check @@ -14083,7 +14435,9 @@ components: - expiry_check title: IssuingAuthorizationVerificationData type: object - x-expandableFields: [] + x-expandableFields: + - authentication_exemption + - three_d_secure issuing_card_apple_pay: description: '' properties: @@ -17152,6 +17506,39 @@ components: title: IssuingTransactionLodgingData type: object x-expandableFields: [] + issuing_transaction_network_data: + description: '' + properties: + authorization_code: + description: >- + A code created by Stripe which is shared with the merchant to + validate the authorization. This field will be populated if the + authorization message was approved. The code typically starts with + the letter "S", followed by a six-digit number. For example, + "S498162". Please note that the code is not guaranteed to be unique + across authorizations. + maxLength: 5000 + nullable: true + type: string + processing_date: + description: >- + The date the transaction was processed by the card network. This can + be different from the date the seller recorded the transaction + depending on when the acquirer submits the transaction to the + network. + maxLength: 5000 + nullable: true + type: string + transaction_id: + description: >- + Unique identifier for the authorization assigned by the card network + used to match subsequent messages, disputes, and transactions. + maxLength: 5000 + nullable: true + type: string + title: IssuingTransactionNetworkData + type: object + x-expandableFields: [] issuing_transaction_purchase_details: description: '' properties: @@ -19973,6 +20360,11 @@ components: - $ref: '#/components/schemas/payment_method_options_promptpay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + revolut_pay: + anyOf: + - $ref: '#/components/schemas/payment_method_options_revolut_pay' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client sepa_debit: anyOf: - $ref: >- @@ -20031,6 +20423,7 @@ components: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -20930,11 +21323,7 @@ components: description: '' properties: dropdown: - anyOf: - - $ref: >- - #/components/schemas/payment_links_resource_custom_fields_dropdown - description: Configuration for `type=dropdown` fields. - nullable: true + $ref: '#/components/schemas/payment_links_resource_custom_fields_dropdown' key: description: >- String of your choice that your integration can use to reconcile @@ -20945,21 +21334,14 @@ components: label: $ref: '#/components/schemas/payment_links_resource_custom_fields_label' numeric: - anyOf: - - $ref: >- - #/components/schemas/payment_links_resource_custom_fields_numeric - description: Configuration for `type=numeric` fields. - nullable: true + $ref: '#/components/schemas/payment_links_resource_custom_fields_numeric' optional: description: >- Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. type: boolean text: - anyOf: - - $ref: '#/components/schemas/payment_links_resource_custom_fields_text' - description: Configuration for `type=text` fields. - nullable: true + $ref: '#/components/schemas/payment_links_resource_custom_fields_text' type: description: The type of the field. enum: @@ -21197,6 +21579,13 @@ components: - manual nullable: true type: string + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. + maxLength: 5000 + nullable: true + type: string metadata: additionalProperties: maxLength: 500 @@ -21534,7 +21923,8 @@ components: description: >- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the - subscription. + subscription for rendering in Stripe surfaces and certain local + payment methods UIs. maxLength: 5000 nullable: true type: string @@ -21716,6 +22106,8 @@ components: $ref: '#/components/schemas/payment_method_promptpay' radar_options: $ref: '#/components/schemas/radar_radar_options' + revolut_pay: + $ref: '#/components/schemas/payment_method_revolut_pay' sepa_debit: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: @@ -21754,6 +22146,7 @@ components: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -21808,6 +22201,7 @@ components: - pix - promptpay - radar_options + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -22472,7 +22866,7 @@ components: - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations) - - [Multiple payment method configurations on dynamic payment + - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs) - [Multiple configurations for your Connect @@ -22749,6 +23143,8 @@ components: $ref: '#/components/schemas/payment_method_details_pix' promptpay: $ref: '#/components/schemas/payment_method_details_promptpay' + revolut_pay: + $ref: '#/components/schemas/payment_method_details_revolut_pay' sepa_debit: $ref: '#/components/schemas/payment_method_details_sepa_debit' sofort: @@ -22813,6 +23209,7 @@ components: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - stripe_account @@ -23113,6 +23510,12 @@ components: maxLength: 5000 nullable: true type: string + capture_before: + description: >- + When using manual capture, a future timestamp at which the charge + will be automatically refunded if uncaptured. + format: unix-time + type: integer checks: anyOf: - $ref: '#/components/schemas/payment_method_details_card_checks' @@ -23416,6 +23819,11 @@ components: maxLength: 5000 nullable: true type: string + offline: + anyOf: + - $ref: '#/components/schemas/payment_method_details_card_present_offline' + description: Details about payments collected offline. + nullable: true overcapture_supported: description: Defines whether the authorized amount can be over-captured or not type: boolean @@ -23444,7 +23852,19 @@ components: title: payment_method_details_card_present type: object x-expandableFields: + - offline - receipt + payment_method_details_card_present_offline: + description: '' + properties: + stored_at: + description: Time at which the payment was collected while offline + format: unix-time + nullable: true + type: integer + title: payment_method_details_card_present_offline + type: object + x-expandableFields: [] payment_method_details_card_present_receipt: description: '' properties: @@ -24363,6 +24783,12 @@ components: title: payment_method_details_promptpay type: object x-expandableFields: [] + payment_method_details_revolut_pay: + description: '' + properties: {} + title: payment_method_details_revolut_pay + type: object + x-expandableFields: [] payment_method_details_sepa_debit: description: '' properties: @@ -24396,7 +24822,11 @@ components: nullable: true type: string mandate: - description: ID of the mandate used to make this payment. + description: >- + Find the ID of the mandate used for this payment under the + [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) + property on the Charge. Use this mandate ID to [retrieve the + Mandate](https://stripe.com/docs/api/mandates/retrieve). maxLength: 5000 nullable: true type: string @@ -25887,6 +26317,12 @@ components: title: payment_method_options_promptpay type: object x-expandableFields: [] + payment_method_options_revolut_pay: + description: '' + properties: {} + title: payment_method_options_revolut_pay + type: object + x-expandableFields: [] payment_method_options_sofort: description: '' properties: @@ -26085,6 +26521,12 @@ components: title: payment_method_promptpay type: object x-expandableFields: [] + payment_method_revolut_pay: + description: '' + properties: {} + title: payment_method_revolut_pay + type: object + x-expandableFields: [] payment_method_sepa_debit: description: '' properties: @@ -26423,11 +26865,8 @@ components: description: '' properties: dropdown: - anyOf: - - $ref: >- - #/components/schemas/payment_pages_checkout_session_custom_fields_dropdown - description: Configuration for `type=dropdown` fields. - nullable: true + $ref: >- + #/components/schemas/payment_pages_checkout_session_custom_fields_dropdown key: description: >- String of your choice that your integration can use to reconcile @@ -26439,22 +26878,16 @@ components: $ref: >- #/components/schemas/payment_pages_checkout_session_custom_fields_label numeric: - anyOf: - - $ref: >- - #/components/schemas/payment_pages_checkout_session_custom_fields_numeric - description: Configuration for `type=numeric` fields. - nullable: true + $ref: >- + #/components/schemas/payment_pages_checkout_session_custom_fields_numeric optional: description: >- Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. type: boolean text: - anyOf: - - $ref: >- - #/components/schemas/payment_pages_checkout_session_custom_fields_text - description: Configuration for `type=text` fields. - nullable: true + $ref: >- + #/components/schemas/payment_pages_checkout_session_custom_fields_text type: description: The type of the field. enum: @@ -27546,6 +27979,8 @@ components: description: The account the person is associated with. maxLength: 5000 type: string + additional_tos_acceptances: + $ref: '#/components/schemas/person_additional_tos_acceptances' address: $ref: '#/components/schemas/address' address_kana: @@ -27693,6 +28128,7 @@ components: title: Person type: object x-expandableFields: + - additional_tos_acceptances - address - address_kana - address_kanji @@ -27703,6 +28139,44 @@ components: - requirements - verification x-resourceId: person + person_additional_tos_acceptance: + description: '' + properties: + date: + description: >- + The Unix timestamp marking when the legal guardian accepted the + service agreement. + format: unix-time + nullable: true + type: integer + ip: + description: >- + The IP address from which the legal guardian accepted the service + agreement. + maxLength: 5000 + nullable: true + type: string + user_agent: + description: >- + The user agent of the browser from which the legal guardian accepted + the service agreement. + maxLength: 5000 + nullable: true + type: string + title: PersonAdditionalTOSAcceptance + type: object + x-expandableFields: [] + person_additional_tos_acceptances: + description: '' + properties: + account: + $ref: '#/components/schemas/person_additional_tos_acceptance' + required: + - account + title: PersonAdditionalTOSAcceptances + type: object + x-expandableFields: + - account person_future_requirements: description: '' properties: @@ -27792,6 +28266,12 @@ components: manage, or direct the organization. nullable: true type: boolean + legal_guardian: + description: >- + Whether the person is the legal guardian of the account's + representative. + nullable: true + type: boolean owner: description: Whether the person is an owner of the account’s legal entity. nullable: true @@ -28604,7 +29084,7 @@ components: description: Whether the feature is enabled. type: boolean products: - description: The list of products that support subscription updates. + description: The list of up to 10 products that support subscription updates. items: $ref: '#/components/schemas/portal_subscription_update_product' nullable: true @@ -29057,8 +29537,6 @@ components: description: The feature's name. Up to 80 characters long. maxLength: 5000 type: string - required: - - name title: ProductFeature type: object x-expandableFields: [] @@ -29672,7 +30150,8 @@ components: description: >- The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the - subscription. + subscription for rendering in Stripe surfaces and certain local + payment methods UIs. maxLength: 5000 nullable: true type: string @@ -29685,6 +30164,22 @@ components: format: unix-time nullable: true type: integer + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + will set metadata on the subscription or subscription schedule when + the quote is accepted. If a recurring price is included in + `line_items`, this field will be passed to the resulting + subscription's `metadata` field. If + `subscription_data.effective_date` is used, this field will be + passed to the resulting subscription schedule's `phases.metadata` + field. Unlike object-level metadata, this field is declarative. + Updates will clear prior values. + nullable: true + type: object trial_period_days: description: >- Integer representing the number of trial period days before the @@ -31313,7 +31808,8 @@ components: type: string checks: anyOf: - - $ref: '#/components/schemas/payment_method_details_card_checks' + - $ref: >- + #/components/schemas/setup_attempt_payment_method_details_card_checks description: >- Check results by Card networks on Card address and CVC at the time of authorization @@ -31389,6 +31885,33 @@ components: - checks - three_d_secure - wallet + setup_attempt_payment_method_details_card_checks: + description: '' + properties: + address_line1_check: + description: >- + If a address line1 was provided, results of the check, one of + `pass`, `fail`, `unavailable`, or `unchecked`. + maxLength: 5000 + nullable: true + type: string + address_postal_code_check: + description: >- + If a address postal code was provided, results of the check, one of + `pass`, `fail`, `unavailable`, or `unchecked`. + maxLength: 5000 + nullable: true + type: string + cvc_check: + description: >- + If a CVC was provided, results of the check, one of `pass`, `fail`, + `unavailable`, or `unchecked`. + maxLength: 5000 + nullable: true + type: string + title: setup_attempt_payment_method_details_card_checks + type: object + x-expandableFields: [] setup_attempt_payment_method_details_card_present: description: '' properties: @@ -34062,7 +34585,8 @@ 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. + subscription for rendering in Stripe surfaces and certain local + payment methods UIs. maxLength: 500 nullable: true type: string @@ -34934,7 +35458,8 @@ components: description: >- Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the - subscription. + subscription for rendering in Stripe surfaces and certain local + payment methods UIs. maxLength: 5000 nullable: true type: string @@ -35089,7 +35614,8 @@ components: description: >- Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the - subscription. + subscription for rendering in Stripe surfaces and certain local + payment methods UIs. maxLength: 5000 nullable: true type: string @@ -35607,6 +36133,90 @@ components: x-expandableFields: - tax_breakdown x-resourceId: tax.calculation_line_item + tax.registration: + description: >- + A Tax `Registration` lets us know that your business is registered to + collect tax on payments within a region, enabling you to [automatically + collect tax](https://stripe.com/docs/tax). + + + 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). + + + Related guide: [Using the Registrations + API](https://stripe.com/docs/tax/registrations-api) + properties: + active_from: + description: >- + Time at which the registration becomes active. Measured in seconds + since the Unix epoch. + format: unix-time + type: integer + country: + description: >- + Two-letter country code ([ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + maxLength: 5000 + type: string + country_options: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + expires_at: + description: >- + If set, the registration stops being active at this time. If not + set, the registration will be active indefinitely. Measured in + seconds since the Unix epoch. + format: unix-time + nullable: true + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - tax.registration + type: string + status: + description: >- + The status of the registration. This field is present for + convenience and can be deduced from `active_from` and `expires_at`. + enum: + - active + - expired + - scheduled + type: string + required: + - active_from + - country + - country_options + - created + - id + - livemode + - object + - status + title: TaxProductRegistrationsResourceTaxRegistration + type: object + x-expandableFields: + - country_options + x-resourceId: tax.registration tax.settings: description: >- You can use Tax `Settings` to manage configurations used by Stripe Tax @@ -36155,6 +36765,362 @@ components: title: tax_id_verification type: object x-expandableFields: [] + tax_product_registrations_resource_country_options: + description: '' + properties: + ae: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + at: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + au: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + be: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + bg: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + ca: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_canada + ch: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + cl: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + co: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + cy: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + cz: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + de: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + dk: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + ee: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + es: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + fi: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + fr: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + gb: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + gr: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + hr: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + hu: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + id: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + ie: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + is: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + it: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + jp: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + kr: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + lt: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + lu: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + lv: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + mt: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + mx: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + my: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + nl: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + 'no': + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + nz: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + pl: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + pt: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + ro: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + sa: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + se: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + sg: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + si: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + sk: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_europe + th: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + tr: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + us: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_united_states + vn: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + za: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default + title: TaxProductRegistrationsResourceCountryOptions + type: object + x-expandableFields: + - ae + - at + - au + - be + - bg + - ca + - ch + - cl + - co + - cy + - cz + - de + - dk + - ee + - es + - fi + - fr + - gb + - gr + - hr + - hu + - id + - ie + - is + - it + - jp + - kr + - lt + - lu + - lv + - mt + - mx + - my + - nl + - 'no' + - nz + - pl + - pt + - ro + - sa + - se + - sg + - si + - sk + - th + - tr + - us + - vn + - za + tax_product_registrations_resource_country_options_ca_province_standard: + description: '' + properties: + province: + description: >- + Two-letter CA province code ([ISO + 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). + maxLength: 5000 + type: string + required: + - province + title: TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard + type: object + x-expandableFields: [] + tax_product_registrations_resource_country_options_canada: + description: '' + properties: + province_standard: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard + type: + description: Type of registration in Canada. + enum: + - province_standard + - simplified + - standard + type: string + required: + - type + title: TaxProductRegistrationsResourceCountryOptionsCanada + type: object + x-expandableFields: + - province_standard + tax_product_registrations_resource_country_options_default: + description: '' + properties: + type: + description: Type of registration in `country`. + enum: + - standard + type: string + required: + - type + title: TaxProductRegistrationsResourceCountryOptionsDefault + type: object + x-expandableFields: [] + tax_product_registrations_resource_country_options_eu_standard: + description: '' + properties: + place_of_supply_scheme: + description: Place of supply scheme used in an EU standard registration. + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: TaxProductRegistrationsResourceCountryOptionsEuStandard + type: object + x-expandableFields: [] + tax_product_registrations_resource_country_options_europe: + description: '' + properties: + standard: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_eu_standard + type: + description: Type of registration in an EU country. + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: TaxProductRegistrationsResourceCountryOptionsEurope + type: object + x-expandableFields: + - standard + tax_product_registrations_resource_country_options_simplified: + description: '' + properties: + type: + description: Type of registration in `country`. + enum: + - simplified + type: string + required: + - type + title: TaxProductRegistrationsResourceCountryOptionsSimplified + type: object + x-expandableFields: [] + tax_product_registrations_resource_country_options_united_states: + description: '' + properties: + local_amusement_tax: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax + local_lease_tax: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax + state: + description: >- + Two-letter US state code ([ISO + 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). + maxLength: 5000 + type: string + type: + description: Type of registration in the US. + enum: + - local_amusement_tax + - local_lease_tax + - state_communications_tax + - state_sales_tax + type: string + required: + - state + - type + title: TaxProductRegistrationsResourceCountryOptionsUnitedStates + type: object + x-expandableFields: + - local_amusement_tax + - local_lease_tax + tax_product_registrations_resource_country_options_us_local_amusement_tax: + description: '' + properties: + jurisdiction: + description: >- + A [FIPS + code](https://www.census.gov/library/reference/code-lists/ansi.html) + representing the local jurisdiction. + maxLength: 5000 + type: string + required: + - jurisdiction + title: TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax + type: object + x-expandableFields: [] + tax_product_registrations_resource_country_options_us_local_lease_tax: + description: '' + properties: + jurisdiction: + description: >- + A [FIPS + code](https://www.census.gov/library/reference/code-lists/ansi.html) + representing the local jurisdiction. + maxLength: 5000 + type: string + required: + - jurisdiction + title: TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax + type: object + x-expandableFields: [] tax_product_resource_customer_details: description: '' properties: @@ -36914,6 +37880,9 @@ components: enum: - terminal.configuration type: string + offline: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_offline_config tipping: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_tipping @@ -36928,6 +37897,7 @@ components: type: object x-expandableFields: - bbpos_wisepos_e + - offline - tipping - verifone_p400 x-resourceId: terminal.configuration @@ -37163,6 +38133,18 @@ components: type: object x-expandableFields: - splashscreen + terminal_configuration_configuration_resource_offline_config: + description: '' + properties: + enabled: + description: >- + Determines whether to allow transactions to be collected while + reader is offline. Defaults to false. + nullable: true + type: boolean + title: TerminalConfigurationConfigurationResourceOfflineConfig + type: object + x-expandableFields: [] terminal_configuration_configuration_resource_tipping: description: '' properties: @@ -37894,10 +38876,8 @@ components: anyOf: - $ref: '#/components/schemas/source' description: >- - For most Stripe users, the source of every top-up is a bank account. - This hash is then the [source - object](https://stripe.com/docs/api#source_object) describing that - bank account. + The source field is deprecated. It might not always be present in + the API response. nullable: true statement_descriptor: description: >- @@ -40958,7 +41938,7 @@ info: details. termsOfService: 'https://stripe.com/us/terms/' title: Stripe API - version: '2023-08-16' + version: '2023-10-16' x-stripeSpecFilename: spec3 openapi: 3.0.0 paths: @@ -41638,6 +42618,12 @@ paths: type: boolean title: capability_param type: object + revolut_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object sepa_debit_payments: properties: requested: @@ -42205,6 +43191,12 @@ paths: Options for customizing how the account functions within Stripe. properties: + bacs_debit_payments: + properties: + display_name: + type: string + title: bacs_debit_payments_specs + type: object branding: properties: icon: @@ -42804,6 +43796,12 @@ paths: type: boolean title: capability_param type: object + revolut_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object sepa_debit_payments: properties: requested: @@ -43356,6 +44354,12 @@ paths: Options for customizing how the account functions within Stripe. properties: + bacs_debit_payments: + properties: + display_name: + type: string + title: bacs_debit_payments_specs + type: object branding: properties: icon: @@ -44737,6 +45741,8 @@ paths: type: boolean executive: type: boolean + legal_guardian: + type: boolean owner: type: boolean representative: @@ -44824,6 +45830,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + additional_tos_acceptances: + explode: true + style: deepObject address: explode: true style: deepObject @@ -44860,263 +45869,286 @@ paths: schema: additionalProperties: false properties: - address: - description: The person's address. - properties: - city: - maxLength: 100 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 200 - type: string - line2: - maxLength: 200 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - title: address_specs - type: object - address_kana: - description: The Kana variation of the person's address (Japan only). - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - town: - maxLength: 5000 - type: string - title: japan_address_kana_specs - type: object - address_kanji: - description: The Kanji variation of the person's address (Japan only). - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - town: - maxLength: 5000 - type: string - title: japan_address_kanji_specs - type: object - dob: - anyOf: - - properties: - day: - type: integer - month: - type: integer - year: - type: integer - required: - - day - - month - - year - title: date_of_birth_specs - type: object - - enum: - - '' - type: string - description: The person's date of birth. - documents: + additional_tos_acceptances: description: >- - Documents that may be submitted to satisfy various - informational requests. + Details on the legal guardian's acceptance of the required + Stripe agreements. properties: - company_authorization: - properties: - files: - items: - anyOf: - - maxLength: 500 - type: string - - enum: - - '' - type: string - type: array - title: documents_param - type: object - passport: - properties: - files: - items: - anyOf: - - maxLength: 500 - type: string - - enum: - - '' - type: string - type: array - title: documents_param - type: object - visa: + account: properties: - files: - items: - anyOf: - - maxLength: 500 - type: string - - enum: - - '' - type: string - type: array - title: documents_param + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: settings_terms_of_service_specs type: object - title: person_documents_specs + title: person_additional_tos_acceptances_specs type: object - email: - description: The person's email address. - type: string - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - first_name: - description: The person's first name. - maxLength: 5000 - type: string - first_name_kana: - description: The Kana variation of the person's first name (Japan only). - maxLength: 5000 - type: string - first_name_kanji: - description: The Kanji variation of the person's first name (Japan only). - maxLength: 5000 - type: string - full_name_aliases: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - description: >- - A list of alternate names or aliases that the person is - known by. - gender: - description: >- - The person's gender (International regulations require - either "male" or "female"). - type: string - id_number: - description: >- - The person's ID number, as appropriate for their country. - For example, a social security number in the U.S., social - insurance number in Canada, etc. Instead of the number - itself, you can also provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). - maxLength: 5000 - type: string - id_number_secondary: - description: >- - The person's secondary ID number, as appropriate for their - country, will be used for enhanced verification checks. In - Thailand, this would be the laser code found on the back of - an ID card. Instead of the number itself, you can also - provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). - maxLength: 5000 - type: string - last_name: - description: The person's last name. - maxLength: 5000 - type: string - last_name_kana: - description: The Kana variation of the person's last name (Japan only). - maxLength: 5000 - type: string - last_name_kanji: - description: The Kanji variation of the person's last name (Japan only). - maxLength: 5000 - type: string - maiden_name: - description: The person's maiden name. - maxLength: 5000 - type: string - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string - description: >- - Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can - attach to an object. This can be useful for storing - additional information about the object in a structured - format. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. - nationality: - description: >- - The country where the person is a national. Two-letter - country code ([ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), - or "XX" if unavailable. - maxLength: 5000 - type: string - person_token: - description: >- - A [person - token](https://stripe.com/docs/connect/account-tokens), used - to securely provide details to the person. - maxLength: 5000 - type: string - phone: - description: The person's phone number. - type: string - political_exposure: - description: >- - Indicates if the person or any of their representatives, - family members, or other closely related persons, declares - that they hold or have held an important public job or - function, in any jurisdiction. - maxLength: 5000 - type: string - registered_address: - description: The person's registered address. + address: + description: The person's address. + properties: + city: + maxLength: 100 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 200 + type: string + line2: + maxLength: 200 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address_specs + type: object + address_kana: + description: The Kana variation of the person's address (Japan only). + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + town: + maxLength: 5000 + type: string + title: japan_address_kana_specs + type: object + address_kanji: + description: The Kanji variation of the person's address (Japan only). + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + town: + maxLength: 5000 + type: string + title: japan_address_kanji_specs + type: object + dob: + anyOf: + - properties: + day: + type: integer + month: + type: integer + year: + type: integer + required: + - day + - month + - year + title: date_of_birth_specs + type: object + - enum: + - '' + type: string + description: The person's date of birth. + documents: + description: >- + Documents that may be submitted to satisfy various + informational requests. + properties: + company_authorization: + properties: + files: + items: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + type: array + title: documents_param + type: object + passport: + properties: + files: + items: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + type: array + title: documents_param + type: object + visa: + properties: + files: + items: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + type: array + title: documents_param + type: object + title: person_documents_specs + type: object + email: + description: The person's email address. + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + first_name: + description: The person's first name. + maxLength: 5000 + type: string + first_name_kana: + description: The Kana variation of the person's first name (Japan only). + maxLength: 5000 + type: string + first_name_kanji: + description: The Kanji variation of the person's first name (Japan only). + maxLength: 5000 + type: string + full_name_aliases: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + description: >- + A list of alternate names or aliases that the person is + known by. + gender: + description: >- + The person's gender (International regulations require + either "male" or "female"). + type: string + id_number: + description: >- + The person's ID number, as appropriate for their country. + For example, a social security number in the U.S., social + insurance number in Canada, etc. Instead of the number + itself, you can also provide a [PII token provided by + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + maxLength: 5000 + type: string + id_number_secondary: + description: >- + The person's secondary ID number, as appropriate for their + country, will be used for enhanced verification checks. In + Thailand, this would be the laser code found on the back of + an ID card. Instead of the number itself, you can also + provide a [PII token provided by + Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + maxLength: 5000 + type: string + last_name: + description: The person's last name. + maxLength: 5000 + type: string + last_name_kana: + description: The Kana variation of the person's last name (Japan only). + maxLength: 5000 + type: string + last_name_kanji: + description: The Kanji variation of the person's last name (Japan only). + maxLength: 5000 + type: string + maiden_name: + description: The person's maiden name. + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://stripe.com/docs/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + nationality: + description: >- + The country where the person is a national. Two-letter + country code ([ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), + or "XX" if unavailable. + maxLength: 5000 + type: string + person_token: + description: >- + A [person + token](https://stripe.com/docs/connect/account-tokens), used + to securely provide details to the person. + maxLength: 5000 + type: string + phone: + description: The person's phone number. + type: string + political_exposure: + description: >- + Indicates if the person or any of their representatives, + family members, or other closely related persons, declares + that they hold or have held an important public job or + function, in any jurisdiction. + maxLength: 5000 + type: string + registered_address: + description: The person's registered address. properties: city: maxLength: 100 @@ -45147,6 +46179,8 @@ paths: type: boolean executive: type: boolean + legal_guardian: + type: boolean owner: type: boolean percent_ownership: @@ -45327,6 +46361,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + additional_tos_acceptances: + explode: true + style: deepObject address: explode: true style: deepObject @@ -45363,6 +46400,29 @@ paths: schema: additionalProperties: false properties: + additional_tos_acceptances: + description: >- + Details on the legal guardian's acceptance of the required + Stripe agreements. + properties: + account: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: settings_terms_of_service_specs + type: object + title: person_additional_tos_acceptances_specs + type: object address: description: The person's address. properties: @@ -45650,6 +46710,8 @@ paths: type: boolean executive: type: boolean + legal_guardian: + type: boolean owner: type: boolean percent_ownership: @@ -45771,6 +46833,8 @@ paths: type: boolean executive: type: boolean + legal_guardian: + type: boolean owner: type: boolean representative: @@ -45858,6 +46922,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + additional_tos_acceptances: + explode: true + style: deepObject address: explode: true style: deepObject @@ -45894,6 +46961,29 @@ paths: schema: additionalProperties: false properties: + additional_tos_acceptances: + description: >- + Details on the legal guardian's acceptance of the required + Stripe agreements. + properties: + account: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: settings_terms_of_service_specs + type: object + title: person_additional_tos_acceptances_specs + type: object address: description: The person's address. properties: @@ -46181,6 +47271,8 @@ paths: type: boolean executive: type: boolean + legal_guardian: + type: boolean owner: type: boolean percent_ownership: @@ -46361,6 +47453,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + additional_tos_acceptances: + explode: true + style: deepObject address: explode: true style: deepObject @@ -46397,6 +47492,29 @@ paths: schema: additionalProperties: false properties: + additional_tos_acceptances: + description: >- + Details on the legal guardian's acceptance of the required + Stripe agreements. + properties: + account: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: settings_terms_of_service_specs + type: object + title: person_additional_tos_acceptances_specs + type: object address: description: The person's address. properties: @@ -46684,6 +47802,8 @@ paths: type: boolean executive: type: boolean + legal_guardian: + type: boolean owner: type: boolean percent_ownership: @@ -48080,243 +49200,245 @@ paths: `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, - `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, - `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, - `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, - `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, - or `transfer_refund`. - in: query - name: type - required: false - schema: - maxLength: 5000 - type: string - style: form - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/balance_transaction' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - pattern: ^/v1/balance_transactions - type: string - required: - - data - - has_more - - object - - url - title: BalanceTransactionsList - type: object - x-expandableFields: - - data - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/balance/history/{id}': - get: - description: >- -

Retrieves the balance transaction with the given ID.

- - -

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

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

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

- - -

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

- operationId: GetBalanceTransactions - parameters: - - explode: true - in: query - name: created - required: false - schema: - anyOf: - - properties: - gt: - type: integer - gte: - type: integer - lt: - type: integer - lte: - type: integer - title: range_query_specs - type: object - - type: integer - style: deepObject - - description: >- - Only return transactions in a certain currency. Three-letter [ISO - currency code](https://www.iso.org/iso-4217-currency-codes.html), in - lowercase. Must be a [supported - currency](https://stripe.com/docs/currencies). - in: query - name: currency - required: false - schema: - type: string - style: form - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form - - description: >- - For automatic Stripe payouts only, only returns transactions that - were paid out on the specified payout ID. - in: query - name: payout - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Only returns the original transaction. - in: query - name: source - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - A cursor for use in pagination. `starting_after` is an object ID - that defines your place in the list. For instance, if you make a - list request and receive 100 objects, ending with `obj_foo`, your - subsequent call can include `starting_after=obj_foo` in order to - fetch the next page of the list. - in: query - name: starting_after - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - Only returns transactions of the given type. One of: `adjustment`, - `advance`, `advance_funding`, `anticipation_repayment`, - `application_fee`, `application_fee_refund`, `charge`, - `connect_collection_transfer`, `contribution`, - `issuing_authorization_hold`, `issuing_authorization_release`, - `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, - `obligation_outbound`, `obligation_reversal_inbound`, - `obligation_reversal_outbound`, `obligation_payout`, - `obligation_payout_failure`, `payment`, `payment_failure_refund`, - `payment_refund`, `payment_reversal`, `payout`, `payout_cancel`, - `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, - `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, - `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, - or `transfer_refund`. + `payment_refund`, `payment_reversal`, `payment_unreconciled`, + `payout`, `payout_cancel`, `payout_failure`, `refund`, + `refund_failure`, `reserve_transaction`, `reserved_funds`, + `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, + `transfer`, `transfer_cancel`, `transfer_failure`, or + `transfer_refund`. + in: query + name: type + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/balance_transaction' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/balance_transactions + type: string + required: + - data + - has_more + - object + - url + title: BalanceTransactionsList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/balance/history/{id}': + get: + description: >- +

Retrieves the balance transaction with the given ID.

+ + +

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

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

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

+ + +

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

+ operationId: GetBalanceTransactions + parameters: + - explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject + - description: >- + Only return transactions in a certain currency. Three-letter [ISO + currency code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + in: query + name: currency + required: false + schema: + type: string + style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + For automatic Stripe payouts only, only returns transactions that + were paid out on the specified payout ID. + in: query + name: payout + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Only returns the original transaction. + in: query + name: source + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A cursor for use in pagination. `starting_after` is an object ID + that defines your place in the list. For instance, if you make a + list request and receive 100 objects, ending with `obj_foo`, your + subsequent call can include `starting_after=obj_foo` in order to + fetch the next page of the list. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Only returns transactions of the given type. One of: `adjustment`, + `advance`, `advance_funding`, `anticipation_repayment`, + `application_fee`, `application_fee_refund`, `charge`, + `connect_collection_transfer`, `contribution`, + `issuing_authorization_hold`, `issuing_authorization_release`, + `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, + `obligation_outbound`, `obligation_reversal_inbound`, + `obligation_reversal_outbound`, `obligation_payout`, + `obligation_payout_failure`, `payment`, `payment_failure_refund`, + `payment_refund`, `payment_reversal`, `payment_unreconciled`, + `payout`, `payout_cancel`, `payout_failure`, `refund`, + `refund_failure`, `reserve_transaction`, `reserved_funds`, + `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, + `transfer`, `transfer_cancel`, `transfer_failure`, or + `transfer_refund`. in: query name: type required: false @@ -49710,7 +50832,7 @@ paths: session: maxLength: 5000 type: string - title: radar_options + title: radar_options_with_hidden_options type: object receipt_email: description: >- @@ -51123,6 +52245,17 @@ paths: maxLength: 5000 type: string style: form + - description: Only return the Checkout Sessions matching the given status. + in: query + name: status + required: false + schema: + enum: + - complete + - expired + - open + type: string + style: form - description: Only return the Checkout Session for the subscription specified. in: query name: subscription @@ -51330,7 +52463,8 @@ paths: 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](https://stripe.com/docs/currencies). Required in + `setup` mode when `payment_method_types` is not set. type: string custom_fields: description: >- @@ -51456,7 +52590,7 @@ paths: customer: description: >- ID of an existing Customer, if one exists. In `payment` - mode, the customer’s most recent card + mode, the customer’s most recently saved card payment method will be used to prefill the email, name, card details, and billing address @@ -51465,10 +52599,10 @@ paths: [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) - will be used if it’s a card, and otherwise the most recent - 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. + 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 @@ -52296,6 +53430,15 @@ paths: type: integer title: payment_method_options_param type: object + revolut_pay: + properties: + setup_future_usage: + enum: + - none + - off_session + type: string + title: payment_method_options_param + type: object sepa_debit: properties: setup_future_usage: @@ -52380,11 +53523,13 @@ paths: Checkout Session can accept. - In `payment` and `subscription` mode, you can omit this - attribute to manage your payment methods from the [Stripe + You can omit this attribute to manage your payment methods + from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). - It is required in `setup` mode. + See [Dynamic Payment + Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) + for more details. Read more about the supported payment methods and their @@ -52429,6 +53574,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -52936,10 +54082,13 @@ paths: is complete. - If you’d like to use information from the successful - Checkout Session on your page, + This parameter is not allowed if ui_mode is `embedded`. If + you’d like to use + + information from the successful Checkout Session on your + page, read the - read the guide on [customizing your success + guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). maxLength: 5000 type: string @@ -54022,6 +55171,27 @@ paths: type: string quantity: type: integer + tax_amounts: + anyOf: + - items: + properties: + amount: + type: integer + tax_rate: + maxLength: 5000 + type: string + taxable_amount: + type: integer + required: + - amount + - tax_rate + - taxable_amount + title: tax_amount_with_tax_rate_param + type: object + type: array + - enum: + - '' + type: string tax_rates: anyOf: - items: @@ -54185,6 +55355,27 @@ paths: type: string quantity: type: integer + tax_amounts: + anyOf: + - items: + properties: + amount: + type: integer + tax_rate: + maxLength: 5000 + type: string + taxable_amount: + type: integer + required: + - amount + - tax_rate + - taxable_amount + title: tax_amount_with_tax_rate_param + type: object + type: array + - enum: + - '' + type: string tax_rates: anyOf: - items: @@ -54408,6 +55599,27 @@ paths: type: string quantity: type: integer + tax_amounts: + anyOf: + - items: + properties: + amount: + type: integer + tax_rate: + maxLength: 5000 + type: string + taxable_amount: + type: integer + required: + - amount + - tax_rate + - taxable_amount + title: tax_amount_with_tax_rate_param + type: object + type: array + - enum: + - '' + type: string tax_rates: anyOf: - items: @@ -58079,6 +59291,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -62036,7 +63249,7 @@ paths: - has_more - object - url - title: FileFileLinkList + title: FileResourceFileLinkList type: object x-expandableFields: - data @@ -62382,7 +63595,7 @@ paths: - has_more - object - url - title: FileFileList + title: FileResourceFileList type: object x-expandableFields: - data @@ -67960,6 +69173,308 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/invoices/{invoice}/lines/{line_item_id}': + post: + description: >- +

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

+ operationId: PostInvoicesInvoiceLinesLineItemId + parameters: + - description: Invoice ID of line item + in: path + name: invoice + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: Invoice line item ID + in: path + name: line_item_id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + discounts: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + period: + explode: true + style: deepObject + price_data: + explode: true + style: deepObject + tax_amounts: + explode: true + style: deepObject + tax_rates: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: + description: >- + The integer amount in cents (or local equivalent) of the + charge to be applied to the upcoming invoice. If you want to + apply a credit to the customer's account, pass a negative + amount. + type: integer + description: + description: >- + An arbitrary string which you can attach to the invoice + item. The description is displayed in the invoice for easy + tracking. + maxLength: 5000 + type: string + discountable: + description: >- + Controls whether discounts apply to this line item. Defaults + to false for prorations or negative line items, and true for + all other line items. Cannot be set to true for prorations. + type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons & existing discounts which apply to the line + item. Item discounts are applied before invoice discounts. + Pass an empty string to remove previously-defined discounts. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://stripe.com/docs/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + period: + description: >- + The period associated with this invoice item. When set to + different values, the period will be rendered on the + invoice. If you have [Stripe Revenue + Recognition](https://stripe.com/docs/revenue-recognition) + enabled, the period will be used to recognize and defer + revenue. See the [Revenue Recognition + documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) + for details. + properties: + end: + format: unix-time + type: integer + start: + format: unix-time + type: integer + required: + - end + - start + title: period + type: object + price: + description: The ID of the price object. + maxLength: 5000 + type: string + price_data: + description: >- + Data used to generate a new + [Price](https://stripe.com/docs/api/prices) object inline. + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + product_data: + properties: + description: + maxLength: 40000 + type: string + images: + items: + type: string + type: array + metadata: + additionalProperties: + type: string + type: object + name: + maxLength: 5000 + type: string + tax_code: + maxLength: 5000 + type: string + required: + - name + title: product_data + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + title: one_time_price_data_with_product_data + type: object + quantity: + description: >- + Non-negative integer. The quantity of units for the line + item. + type: integer + tax_amounts: + anyOf: + - items: + properties: + amount: + type: integer + tax_rate_data: + properties: + country: + maxLength: 5000 + type: string + description: + maxLength: 5000 + type: string + display_name: + maxLength: 50 + type: string + inclusive: + type: boolean + jurisdiction: + maxLength: 50 + type: string + percentage: + type: number + state: + maxLength: 2 + type: string + tax_type: + enum: + - amusement_tax + - communications_tax + - gst + - hst + - igst + - jct + - lease_tax + - pst + - qst + - rst + - sales_tax + - service_tax + - vat + type: string + required: + - display_name + - inclusive + - percentage + title: tax_rate_data_param + type: object + taxable_amount: + type: integer + required: + - amount + - tax_rate_data + - taxable_amount + title: tax_amount_param + type: object + type: array + - enum: + - '' + type: string + description: >- + A list of up to 10 tax amounts for this line item. This can + be useful if you calculate taxes on your own or use a + third-party to calculate them. You cannot set tax amounts if + any line item has + [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) + or if the invoice has + [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) + or uses [automatic + tax](https://stripe.com/docs/tax/invoicing). Pass an empty + string to remove previously defined tax amounts. + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + description: >- + The tax rates which apply to the line item. When set, the + `default_tax_rates` on the invoice do not apply to this line + item. Pass an empty string to remove previously-defined tax + rates. + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/line_item' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. '/v1/invoices/{invoice}/mark_uncollectible': post: description: >- @@ -76781,6 +78296,10 @@ paths: type: string title: radar_options type: object + revolut_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -76832,6 +78351,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -77218,11 +78738,6 @@ paths: - properties: request_extended_authorization: type: boolean - request_incremental_authorization: - enum: - - if_available - - never - type: string request_incremental_authorization_support: type: boolean title: payment_method_options_param @@ -77615,6 +79130,20 @@ paths: - enum: - '' type: string + revolut_pay: + anyOf: + - properties: + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -77885,7 +79414,7 @@ paths: transfer_data: description: >- The parameters that you can use to automatically create a - Transfer after the payment succeeds. + Transfer. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). @@ -78605,6 +80134,10 @@ paths: type: string title: radar_options type: object + revolut_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -78656,6 +80189,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -79042,11 +80576,6 @@ paths: - properties: request_extended_authorization: type: boolean - request_incremental_authorization: - enum: - - if_available - - never - type: string request_incremental_authorization_support: type: boolean title: payment_method_options_param @@ -79439,6 +80968,20 @@ paths: - enum: - '' type: string + revolut_pay: + anyOf: + - properties: + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -80564,6 +82107,10 @@ paths: type: string title: radar_options type: object + revolut_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -80615,6 +82162,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -81001,11 +82549,6 @@ paths: - properties: request_extended_authorization: type: boolean - request_incremental_authorization: - enum: - - if_available - - never - type: string request_incremental_authorization_support: type: boolean title: payment_method_options_param @@ -81398,6 +82941,20 @@ paths: - enum: - '' type: string + revolut_pay: + anyOf: + - properties: + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -82428,6 +83985,9 @@ paths: - automatic_async - manual type: string + description: + maxLength: 1000 + type: string metadata: additionalProperties: type: string @@ -83265,6 +84825,13 @@ paths: A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. properties: + description: + anyOf: + - maxLength: 1000 + type: string + - enum: + - '' + type: string metadata: anyOf: - additionalProperties: @@ -85995,6 +87562,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -86166,6 +87734,9 @@ paths: radar_options: explode: true style: deepObject + revolut_pay: + explode: true + style: deepObject sepa_debit: explode: true style: deepObject @@ -86653,6 +88224,13 @@ paths: type: string title: radar_options type: object + revolut_pay: + description: >- + If this is a `Revolut Pay` PaymentMethod, this hash contains + details about the Revolut Pay payment method. + properties: {} + title: param + type: object sepa_debit: description: >- If this is a `sepa_debit` PaymentMethod, this hash contains @@ -86716,6 +88294,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -88203,7 +89782,11 @@ paths: description: Error response. /v1/prices: get: - description:

Returns a list of your prices.

+ description: >- +

Returns a list of your active prices, excluding inline + prices. For the list of inactive prices, set active to + false.

operationId: GetPrices parameters: - description: >- @@ -90761,6 +92344,10 @@ paths: - enum: - '' type: string + metadata: + additionalProperties: + type: string + type: object trial_period_days: anyOf: - type: integer @@ -91157,6 +92744,10 @@ paths: - enum: - '' type: string + metadata: + additionalProperties: + type: string + type: object trial_period_days: anyOf: - type: integer @@ -93088,6 +94679,7 @@ paths: - topup_reversal - transfer - transfer_reversal + - unreconciled_customer_funds maxLength: 5000 type: string x-stripeBypassValidation: true @@ -94918,6 +96510,10 @@ paths: type: string title: radar_options type: object + revolut_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -94969,6 +96565,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -95780,6 +97377,10 @@ paths: type: string title: radar_options type: object + revolut_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -95831,6 +97432,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -96623,6 +98225,10 @@ paths: type: string title: radar_options type: object + revolut_pay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -96674,6 +98280,7 @@ paths: - paypal - pix - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -99416,7 +101023,8 @@ paths: - now maxLength: 5000 type: string - - type: integer + - 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 @@ -100031,7 +101639,8 @@ paths: type: array start_date: anyOf: - - type: integer + - format: unix-time + type: integer - enum: - now maxLength: 5000 @@ -100354,7 +101963,8 @@ paths: type: string end_date: anyOf: - - type: integer + - format: unix-time + type: integer - enum: - now maxLength: 5000 @@ -100456,7 +102066,8 @@ paths: type: string start_date: anyOf: - - type: integer + - format: unix-time + type: integer - enum: - now maxLength: 5000 @@ -100475,7 +102086,8 @@ paths: type: boolean trial_end: anyOf: - - type: integer + - format: unix-time + type: integer - enum: - now maxLength: 5000 @@ -101134,7 +102746,7 @@ paths: 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. + surfaces and certain local payment methods UIs. maxLength: 500 type: string expand: @@ -101900,11 +103512,72 @@ paths: description: Error response. post: description: >- -

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

+

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

+ + +

By default, we prorate subscription changes. For example, if a + customer signs up on May 1 for a 100 price, they’ll + be billed 100 immediately. If on May 15 they switch + to a 200 price, then on June 1 they’ll be billed + 250 (200 for a renewal of her + subscription, plus a 50 prorating adjustment for + half of the previous month’s 100 difference). + Similarly, a downgrade generates a credit that is applied to the next + invoice. We also prorate when you make quantity changes.

+ + +

Switching prices does not normally change the billing date or + generate an immediate charge unless:

+ + +
    + +
  • The billing interval is changed (for example, from monthly to + yearly).
    • + +
  • The subscription moves from free to paid, or paid to free.
    • + +
  • A trial starts or ends.
    • + +
+ + +

In these cases, we apply a credit for the unused time on the previous + price, immediately charge the customer using the new price, and reset + the billing date.

+ + +

If you want to charge for an upgrade immediately, pass + proration_behavior as always_invoice to create + prorations, automatically invoice the customer for those proration + adjustments, and attempt to collect payment. If you pass + create_prorations, the prorations are created but not + automatically invoiced. If you want to bill the customer for the + prorations before the subscription’s renewal date, you need to manually + invoice the customer.

+ + +

If you don’t want to prorate, set the proration_behavior + option to none. With this option, the customer is billed + 100 on May 1 and 200 on June + 1. Similarly, if you set proration_behavior to + none when switching between different billing intervals + (for example, from monthly to yearly), we don’t generate any credits for + the old subscription’s unused time. We still reset the billing date and + bill immediately for the new subscription.

+ + +

Updating the quantity on a subscription many times in an hour may + result in rate limiting. If you need to + bill for a frequently changing quantity, consider integrating usage-based billing + instead.

operationId: PostSubscriptionsSubscriptionExposedId parameters: - in: path @@ -102194,7 +103867,7 @@ paths: 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. + surfaces and certain local payment methods UIs. expand: description: Specifies which fields in the response should be expanded. items: @@ -103217,6 +104890,1186 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/tax/registrations: + get: + description:

Returns a list of Tax Registration objects.

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

Creates a new Tax Registration object.

+ operationId: PostTaxRegistrations + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + active_from: + explode: true + style: deepObject + country_options: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + active_from: + anyOf: + - enum: + - now + maxLength: 5000 + type: string + - format: unix-time + type: integer + description: >- + Time at which the Tax Registration becomes active. It can be + either `now` to indicate the current time, or a future + timestamp measured in seconds since the Unix epoch. + country: + description: >- + Two-letter country code ([ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + maxLength: 5000 + type: string + country_options: + description: >- + Specific options for a registration in the specified + `country`. + properties: + ae: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + at: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + au: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + be: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + bg: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + ca: + properties: + province_standard: + properties: + province: + maxLength: 5000 + type: string + required: + - province + title: province_standard + type: object + type: + enum: + - province_standard + - simplified + - standard + type: string + required: + - type + title: canada + type: object + ch: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + cl: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + co: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + cy: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + cz: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + de: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + dk: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + ee: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + es: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + fi: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + fr: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + gb: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + gr: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + hr: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + hu: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + id: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + ie: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + is: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + it: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + jp: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + kr: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + lt: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + lu: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + lv: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + mt: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + mx: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + my: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + nl: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + 'no': + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + nz: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + pl: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + pt: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + ro: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + sa: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + se: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + sg: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + si: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + sk: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + th: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + tr: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + us: + properties: + local_amusement_tax: + properties: + jurisdiction: + maxLength: 5000 + type: string + required: + - jurisdiction + title: local_amusement_tax + type: object + local_lease_tax: + properties: + jurisdiction: + maxLength: 5000 + type: string + required: + - jurisdiction + title: local_lease_tax + type: object + state: + maxLength: 5000 + type: string + type: + enum: + - local_amusement_tax + - local_lease_tax + - state_communications_tax + - state_sales_tax + type: string + required: + - state + - type + title: united_states + type: object + vn: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + za: + properties: + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + title: country_options + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + expires_at: + description: >- + If set, the Tax Registration stops being active at this + time. If not set, the Tax Registration will be active + indefinitely. Timestamp measured in seconds since the Unix + epoch. + format: unix-time + type: integer + required: + - active_from + - country + - country_options + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tax.registration' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/tax/registrations/{id}': + post: + description: >- +

Updates an existing Tax Registration object.

+ + +

A registration cannot be deleted after it has been created. If you + wish to end a registration you may do so by setting + expires_at.

+ operationId: PostTaxRegistrationsId + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + active_from: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + expires_at: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + active_from: + anyOf: + - enum: + - now + maxLength: 5000 + type: string + - format: unix-time + type: integer + description: >- + Time at which the registration becomes active. It can be + either `now` to indicate the current time, or a timestamp + measured in seconds since the Unix epoch. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + expires_at: + anyOf: + - enum: + - now + maxLength: 5000 + type: string + - format: unix-time + type: integer + - enum: + - '' + type: string + description: >- + If set, the registration stops being active at this time. If + not set, the registration will be active indefinitely. It + can be either `now` to indicate the current time, or a + timestamp measured in seconds since the Unix epoch. + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tax.registration' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/tax/settings: get: description:

Retrieves Tax Settings for a merchant.

@@ -104396,6 +107249,9 @@ paths: expand: explode: true style: deepObject + offline: + explode: true + style: deepObject tipping: explode: true style: deepObject @@ -104424,6 +107280,19 @@ paths: maxLength: 5000 type: string type: array + offline: + anyOf: + - properties: + enabled: + type: boolean + required: + - enabled + title: offline + type: object + - enum: + - '' + type: string + description: Configurations for collecting transactions offline. tipping: anyOf: - properties: @@ -104758,6 +107627,9 @@ paths: expand: explode: true style: deepObject + offline: + explode: true + style: deepObject tipping: explode: true style: deepObject @@ -104790,6 +107662,19 @@ paths: maxLength: 5000 type: string type: array + offline: + anyOf: + - properties: + enabled: + type: boolean + required: + - enabled + title: offline + type: object + - enum: + - '' + type: string + description: Configurations for collecting transactions offline. tipping: anyOf: - properties: @@ -106671,6 +109556,9 @@ paths: terminal_id: maxLength: 5000 type: string + url: + maxLength: 5000 + type: string title: merchant_data_specs type: object network_data: @@ -106700,6 +109588,24 @@ paths: - mismatch - not_provided type: string + authentication_exemption: + properties: + claimed_by: + enum: + - acquirer + - issuer + type: string + type: + enum: + - low_value_transaction + - transaction_risk_analysis + type: string + x-stripeBypassValidation: true + required: + - claimed_by + - type + title: authentication_exemption_specs + type: object cvc_check: enum: - match @@ -106712,6 +109618,20 @@ paths: - mismatch - not_provided type: string + three_d_secure: + properties: + result: + enum: + - attempt_acknowledged + - authenticated + - failed + - required + type: string + x-stripeBypassValidation: true + required: + - result + title: three_d_secure_specs + type: object title: verification_data_specs type: object wallet: @@ -107608,6 +110528,9 @@ paths: terminal_id: maxLength: 5000 type: string + url: + maxLength: 5000 + type: string title: merchant_data_specs type: object purchase_details: @@ -108105,6 +111028,9 @@ paths: terminal_id: maxLength: 5000 type: string + url: + maxLength: 5000 + type: string title: merchant_data_specs type: object purchase_details: @@ -109885,6 +112811,26 @@ paths: person: description: Information for the person this token represents. properties: + additional_tos_acceptances: + properties: + account: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: settings_terms_of_service_specs + type: object + title: person_additional_tos_acceptances_specs + type: object address: properties: city: @@ -110102,6 +113048,8 @@ paths: type: boolean executive: type: boolean + legal_guardian: + type: boolean owner: type: boolean percent_ownership: @@ -114683,6 +117631,7 @@ paths: - '2022-08-01' - '2022-11-15' - '2023-08-16' + - '2023-10-16' maxLength: 5000 type: string x-stripeBypassValidation: true @@ -114807,6 +117756,8 @@ paths: - issuing_dispute.funds_reinstated - issuing_dispute.submitted - issuing_dispute.updated + - issuing_token.created + - issuing_token.updated - issuing_transaction.created - issuing_transaction.updated - mandate.updated @@ -115201,6 +118152,8 @@ paths: - issuing_dispute.funds_reinstated - issuing_dispute.submitted - issuing_dispute.updated + - issuing_token.created + - issuing_token.updated - issuing_transaction.created - issuing_transaction.updated - mandate.updated diff --git a/packages/openapi-typescript/src/transform/schema-object.ts b/packages/openapi-typescript/src/transform/schema-object.ts index f052fbc17..853b93e5d 100644 --- a/packages/openapi-typescript/src/transform/schema-object.ts +++ b/packages/openapi-typescript/src/transform/schema-object.ts @@ -447,7 +447,9 @@ function transformSchemaObjectCore( } let optional = schemaObject.required?.includes(k) || - ("default" in v && options.ctx.defaultNonNullable) + ("default" in v && + options.ctx.defaultNonNullable && + !options.path?.includes("parameters")) // parameters can’t be required, even with defaults ? undefined : QUESTION_TOKEN; let type = diff --git a/packages/openapi-typescript/test/transform/operation-object.test.ts b/packages/openapi-typescript/test/transform/operation-object.test.ts index 5a7a0cad9..de4314f7b 100644 --- a/packages/openapi-typescript/test/transform/operation-object.test.ts +++ b/packages/openapi-typescript/test/transform/operation-object.test.ts @@ -155,6 +155,65 @@ responses: { "application/json": string; }; }; +};`, + }, + ], + [ + "defaultNonNullable > parameters aren’t required even with defaults", + { + given: { + parameters: [ + { + in: "query", + name: "format", + schema: { type: "string", default: "json" }, + }, + ], + responses: { + "200": { + description: "OK", + content: { + "application/json": { + schema: { + type: "object", + properties: { + required: { + type: "string", + default: "true", + }, + optional: { + type: "boolean", + }, + }, + }, + }, + }, + }, + }, + }, + want: `parameters: { + query?: { + format?: string; + }; + header?: never; + path?: never; + cookie?: never; +}; +requestBody?: never; +responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @default true */ + required: string; + optional?: boolean; + }; + }; + }; };`, }, ],